All Documents

fiftyone

index.html

Package

Package

PUBLIC

FiftyOne: a powerful package for dataset curation, analysis, and visualization.
fiftyone.__public__

fiftyone.__public__.html

Module

Module

PUBLIC

FiftyOne's public interface.
fiftyone.constants

fiftyone.constants.html

Module

Module

PUBLIC

Package-wide constants.
fiftyone.core

fiftyone.core.html

Package

Package

PUBLIC

No summary
fiftyone.core.aggregations

fiftyone.core.aggregations.html

Module

Module

PUBLIC

Aggregations.
fiftyone.core.annotation

fiftyone.core.annotation.html

Module

Module

PUBLIC

Annotation runs framework.
fiftyone.core.brain

fiftyone.core.brain.html

Module

Module

PUBLIC

Brain method runs framework.
fiftyone.core.cli

fiftyone.core.cli.html

Module

Module

PUBLIC

Definition of the fiftyone command-line interface (CLI).
fiftyone.core.clips

fiftyone.core.clips.html

Module

Module

PUBLIC

Clips views.
fiftyone.core.collections

fiftyone.core.collections.html

Module

Module

PUBLIC

Interface for sample collections.
fiftyone.core.config

fiftyone.core.config.html

Module

Module

PUBLIC

FiftyOne config.
fiftyone.core.context

fiftyone.core.context.html

Module

Module

PUBLIC

Context utilities.
fiftyone.core.dataset

fiftyone.core.dataset.html

Module

Module

PUBLIC

FiftyOne datasets.
fiftyone.core.document

fiftyone.core.document.html

Module

Module

PUBLIC

Base classes for objects that are backed by database documents.
fiftyone.core.evaluation

fiftyone.core.evaluation.html

Module

Module

PUBLIC

Evaluation runs framework.
fiftyone.core.expressions

fiftyone.core.expressions.html

Module

Module

PUBLIC

Expressions for fiftyone.core.stages.ViewStage definitions.
fiftyone.core.fields

fiftyone.core.fields.html

Module

Module

PUBLIC

Dataset sample fields.
fiftyone.core.frame

fiftyone.core.frame.html

Module

Module

PUBLIC

Video frames.
fiftyone.core.frame_utils

fiftyone.core.frame_utils.html

Module

Module

PUBLIC

Frame utilities.
fiftyone.core.groups

fiftyone.core.groups.html

Module

Module

PUBLIC

Sample groups.
fiftyone.core.json

fiftyone.core.json.html

Module

Module

PUBLIC

FiftyOne JSON handling
fiftyone.core.labels

fiftyone.core.labels.html

Module

Module

PUBLIC

Labels stored in dataset samples.
fiftyone.core.logging

fiftyone.core.logging.html

Module

Module

PUBLIC

Logging utilities.
fiftyone.core.media

fiftyone.core.media.html

Module

Module

PUBLIC

Sample media utilities.
fiftyone.core.metadata

fiftyone.core.metadata.html

Module

Module

PUBLIC

Metadata stored in dataset samples.
fiftyone.core.models

fiftyone.core.models.html

Module

Module

PUBLIC

FiftyOne models.
fiftyone.core.odm

fiftyone.core.odm.html

Package

Package

PUBLIC

ODM package declaration.
fiftyone.core.odm.database

fiftyone.core.odm.database.html

Module

Module

PUBLIC

Database utilities.
fiftyone.core.odm.dataset

fiftyone.core.odm.dataset.html

Module

Module

PUBLIC

Documents that track datasets and their sample schemas in the database.
fiftyone.core.odm.document

fiftyone.core.odm.document.html

Module

Module

PUBLIC

Base classes for documents that back dataset contents.
fiftyone.core.odm.embedded_document

fiftyone.core.odm.embedded_document.html

Module

Module

PUBLIC

Base classes for documents that back dataset contents.
fiftyone.core.odm.frame

fiftyone.core.odm.frame.html

Module

Module

PUBLIC

Backing document classes for fiftyone.core.frame.Frame instances.
fiftyone.core.odm.mixins

fiftyone.core.odm.mixins.html

Module

Module

PUBLIC

Mixins and helpers for dataset backing documents.
fiftyone.core.odm.runs

fiftyone.core.odm.runs.html

Module

Module

PUBLIC

Dataset run documents.
fiftyone.core.odm.sample

fiftyone.core.odm.sample.html

Module

Module

PUBLIC

Backing document classes for fiftyone.core.sample.Sample instances.
fiftyone.core.odm.utils

fiftyone.core.odm.utils.html

Module

Module

PUBLIC

Utilities for documents.
fiftyone.core.odm.views

fiftyone.core.odm.views.html

Module

Module

PUBLIC

Saved view documents.
fiftyone.core.odm.workspace

fiftyone.core.odm.workspace.html

Module

Module

PUBLIC

App Space configuration.
fiftyone.core.patches

fiftyone.core.patches.html

Module

Module

PUBLIC

Patches views.
fiftyone.core.plots

fiftyone.core.plots.html

Package

Package

PUBLIC

Plotting framework.
fiftyone.core.plots.base

fiftyone.core.plots.base.html

Module

Module

PUBLIC

Base plotting definitions.
fiftyone.core.plots.manager

fiftyone.core.plots.manager.html

Module

Module

PUBLIC

Session plot manager.
fiftyone.core.plots.matplotlib

fiftyone.core.plots.matplotlib.html

Module

Module

PUBLIC

Matplotlib plots.
fiftyone.core.plots.plotly

fiftyone.core.plots.plotly.html

Module

Module

PUBLIC

Plotly plots.
fiftyone.core.plots.utils

fiftyone.core.plots.utils.html

Module

Module

PUBLIC

Plotting utils.
fiftyone.core.plots.views

fiftyone.core.plots.views.html

Module

Module

PUBLIC

Plotly-powered view plots.
fiftyone.core.runs

fiftyone.core.runs.html

Module

Module

PUBLIC

Dataset runs framework.
fiftyone.core.sample

fiftyone.core.sample.html

Module

Module

PUBLIC

Dataset samples.
fiftyone.core.service

fiftyone.core.service.html

Module

Module

PUBLIC

FiftyOne Services.
fiftyone.core.session

fiftyone.core.session.html

Package

Package

PUBLIC

Session definitions for interacting with the FiftyOne App.
fiftyone.core.session.client

fiftyone.core.session.client.html

Module

Module

PUBLIC

Session server-sent events client.
fiftyone.core.session.events

fiftyone.core.session.events.html

Module

Module

PUBLIC

Session events.
fiftyone.core.session.notebooks

fiftyone.core.session.notebooks.html

Module

Module

PUBLIC

Session notebook handling.
fiftyone.core.session.session

fiftyone.core.session.session.html

Module

Module

PUBLIC

Session class for interacting with the FiftyOne App.
fiftyone.core.session.templates

fiftyone.core.session.templates.html

Module

Module

PUBLIC

Notebook Session HTML templates
fiftyone.core.singletons

fiftyone.core.singletons.html

Module

Module

PUBLIC

FiftyOne singleton implementations.
fiftyone.core.stages

fiftyone.core.stages.html

Module

Module

PUBLIC

View stages.
fiftyone.core.state

fiftyone.core.state.html

Module

Module

PUBLIC

Defines the shared state between the FiftyOne App and backend.
fiftyone.core.storage

fiftyone.core.storage.html

Module

Module

PUBLIC

File storage utilities.
fiftyone.core.threed

fiftyone.core.threed.html

Package

Package

PUBLIC

3D definitions for FiftyOne.
fiftyone.core.threed.camera

fiftyone.core.threed.camera.html

Module

Module

PUBLIC

Camera definition for 3D visualization.
fiftyone.core.threed.lights

fiftyone.core.threed.lights.html

Module

Module

PUBLIC

Lights definition for 3D visualization.
fiftyone.core.threed.material_3d

fiftyone.core.threed.material_3d.html

Module

Module

PUBLIC

Material definition for 3D visualization.
fiftyone.core.threed.mesh

fiftyone.core.threed.mesh.html

Module

Module

PUBLIC

Mesh definitions for 3D visualization.
fiftyone.core.threed.object_3d

fiftyone.core.threed.object_3d.html

Module

Module

PUBLIC

FiftyOne 3D Object3D base class.
fiftyone.core.threed.pointcloud

fiftyone.core.threed.pointcloud.html

Module

Module

PUBLIC

PointCloud definition for 3D visualization.
fiftyone.core.threed.scene_3d

fiftyone.core.threed.scene_3d.html

Module

Module

PUBLIC

3D scene definitions.
fiftyone.core.threed.shape_3d

fiftyone.core.threed.shape_3d.html

Module

Module

PUBLIC

Mesh definitions for 3D visualization.
fiftyone.core.threed.transformation

fiftyone.core.threed.transformation.html

Module

Module

PUBLIC

No module docstring; 0/2 type alias, 0/1 constant, 0/2 function, 3/3 classes documented
fiftyone.core.threed.utils

fiftyone.core.threed.utils.html

Module

Module

PUBLIC

No summary
fiftyone.core.threed.validators

fiftyone.core.threed.validators.html

Module

Module

PUBLIC

Simple validator utilities
fiftyone.core.uid

fiftyone.core.uid.html

Module

Module

PUBLIC

Utilities for usage analytics.
fiftyone.core.utils

fiftyone.core.utils.html

Module

Module

PUBLIC

Core utilities.
fiftyone.core.validation

fiftyone.core.validation.html

Module

Module

PUBLIC

Validation utilities.
fiftyone.core.video

fiftyone.core.video.html

Module

Module

PUBLIC

Video frame views.
fiftyone.core.view

fiftyone.core.view.html

Module

Module

PUBLIC

Dataset views.
fiftyone.factory

fiftyone.factory.html

Package

Package

PUBLIC

FiftyOne repository factory.
fiftyone.factory.repo_factory

fiftyone.factory.repo_factory.html

Module

Module

PUBLIC

FiftyOne repository factory.
fiftyone.factory.repos

fiftyone.factory.repos.html

Package

Package

PUBLIC

FiftyOne repository factory.
fiftyone.factory.repos.delegated_operation

fiftyone.factory.repos.delegated_operation.html

Module

Module

PUBLIC

FiftyOne delegated operation repository.
fiftyone.factory.repos.delegated_operation_doc

fiftyone.factory.repos.delegated_operation_doc.html

Module

Module

PUBLIC

FiftyOne delegated operation repository document.
fiftyone.factory.repos.execution_store

fiftyone.factory.repos.execution_store.html

Module

Module

PUBLIC

Execution store repository.
fiftyone.internal

fiftyone.internal.html

Package

Package

PUBLIC

Internal classes and utilities.
fiftyone.internal.secrets

fiftyone.internal.secrets.html

Package

Package

PUBLIC

FiftyOne secrets.
fiftyone.internal.secrets.providers

fiftyone.internal.secrets.providers.html

Package

Package

PUBLIC

FiftyOne secrets providers.
fiftyone.internal.secrets.providers.iprovider

fiftyone.internal.secrets.providers.iprovider.html

Module

Module

PUBLIC

FiftyOne secrets provider interface
fiftyone.internal.secrets.providers.local

fiftyone.internal.secrets.providers.local.html

Module

Module

PUBLIC

FiftyOne env secrets provider
fiftyone.internal.secrets.secret

fiftyone.internal.secrets.secret.html

Module

Module

PUBLIC

FiftyOne secret types
fiftyone.internal.util

fiftyone.internal.util.html

Module

Module

PUBLIC

FiftyOne internal utilities.
fiftyone.migrations

fiftyone.migrations.html

Package

Package

PUBLIC

FiftyOne's migration interface.
fiftyone.migrations.runner

fiftyone.migrations.runner.html

Module

Module

PUBLIC

FiftyOne migrations runner.
fiftyone.operators

fiftyone.operators.html

Package

Package

PUBLIC

FiftyOne operators.
fiftyone.operators.categories

fiftyone.operators.categories.html

Module

Module

PUBLIC

Undocumented
fiftyone.operators.decorators

fiftyone.operators.decorators.html

Module

Module

PUBLIC

FiftyOne operator decorators.
fiftyone.operators.delegated

fiftyone.operators.delegated.html

Module

Module

PUBLIC

FiftyOne delegated operations.
fiftyone.operators.evaluation_metric

fiftyone.operators.evaluation_metric.html

Module

Module

PUBLIC

Evaluation metric operators.
fiftyone.operators.events

fiftyone.operators.events.html

Module

Module

PUBLIC

Undocumented
fiftyone.operators.executor

fiftyone.operators.executor.html

Module

Module

PUBLIC

FiftyOne operator execution.
fiftyone.operators.message

fiftyone.operators.message.html

Module

Module

PUBLIC

FiftyOne operator messages.
fiftyone.operators.operations

fiftyone.operators.operations.html

Module

Module

PUBLIC

FiftyOne operator execution.
fiftyone.operators.operator

fiftyone.operators.operator.html

Module

Module

PUBLIC

FiftyOne operators.
fiftyone.operators.panel

fiftyone.operators.panel.html

Module

Module

PUBLIC

FiftyOne panels.
fiftyone.operators.permissions

fiftyone.operators.permissions.html

Module

Module

PUBLIC

FiftyOne operator permissions.
fiftyone.operators.registry

fiftyone.operators.registry.html

Module

Module

PUBLIC

FiftyOne operator registry.
fiftyone.operators.server

fiftyone.operators.server.html

Module

Module

PUBLIC

FiftyOne operator server.
fiftyone.operators.store

fiftyone.operators.store.html

Package

Package

PUBLIC

Execution store.
fiftyone.operators.store.models

fiftyone.operators.store.models.html

Module

Module

PUBLIC

Execution store models.
fiftyone.operators.store.service

fiftyone.operators.store.service.html

Module

Module

PUBLIC

Execution store service.
fiftyone.operators.store.store

fiftyone.operators.store.store.html

Module

Module

PUBLIC

Execution store class.
fiftyone.operators.types

fiftyone.operators.types.html

Module

Module

PUBLIC

FiftyOne operator types.
fiftyone.operators.utils

fiftyone.operators.utils.html

Module

Module

PUBLIC

FiftyOne operator utilities.
fiftyone.plugins

fiftyone.plugins.html

Package

Package

PUBLIC

FiftyOne plugins.
fiftyone.plugins.constants

fiftyone.plugins.constants.html

Module

Module

PUBLIC

FiftyOne plugins constants.
fiftyone.plugins.context

fiftyone.plugins.context.html

Module

Module

PUBLIC

FiftyOne plugin context.
fiftyone.plugins.core

fiftyone.plugins.core.html

Module

Module

PUBLIC

Core plugin methods.
fiftyone.plugins.definitions

fiftyone.plugins.definitions.html

Module

Module

PUBLIC

Plugin definitions.
fiftyone.plugins.secrets

fiftyone.plugins.secrets.html

Module

Module

PUBLIC

Plugin secrets resolver.
fiftyone.plugins.utils

fiftyone.plugins.utils.html

Module

Module

PUBLIC

FiftyOne plugin utilities.
fiftyone.server

fiftyone.server.html

Package

Package

PUBLIC

FiftyOne Server
fiftyone.server.aggregate

fiftyone.server.aggregate.html

Module

Module

PUBLIC

FiftyOne Server aggregations
fiftyone.server.aggregations

fiftyone.server.aggregations.html

Module

Module

PUBLIC

FiftyOne Server aggregations
fiftyone.server.app

fiftyone.server.app.html

Module

Module

PUBLIC

FiftyOne Server app.
fiftyone.server.color

fiftyone.server.color.html

Module

Module

PUBLIC

FiftyOne Server coloring
fiftyone.server.constants

fiftyone.server.constants.html

Module

Module

PUBLIC

FiftyOne Server constants
fiftyone.server.context

fiftyone.server.context.html

Module

Module

PUBLIC

FiftyOne Server context
fiftyone.server.data

fiftyone.server.data.html

Module

Module

PUBLIC

FiftyOne Server data
fiftyone.server.dataloader

fiftyone.server.dataloader.html

Module

Module

PUBLIC

FiftyOne Server dataloader
fiftyone.server.decorators

fiftyone.server.decorators.html

Module

Module

PUBLIC

FiftyOne Server decorators
fiftyone.server.events

fiftyone.server.events.html

Package

Package

PUBLIC

FiftyOne Server events.
fiftyone.server.events.dispatch

fiftyone.server.events.dispatch.html

Module

Module

PUBLIC

FiftyOne Server events dispatching.
fiftyone.server.events.initialize

fiftyone.server.events.initialize.html

Module

Module

PUBLIC

FiftyOne Server events initialization.
fiftyone.server.events.listener

fiftyone.server.events.listener.html

Module

Module

PUBLIC

FiftyOne Server events listening.
fiftyone.server.events.polling

fiftyone.server.events.polling.html

Module

Module

PUBLIC

FiftyOne Server events polling.
fiftyone.server.events.state

fiftyone.server.events.state.html

Module

Module

PUBLIC

FiftyOne Server events state.
fiftyone.server.extensions

fiftyone.server.extensions.html

Module

Module

PUBLIC

FiftyOne Server extensions
fiftyone.server.filters

fiftyone.server.filters.html

Module

Module

PUBLIC

FiftyOne Server filter inputs
fiftyone.server.indexes

fiftyone.server.indexes.html

Module

Module

PUBLIC

FiftyOne Server indexes.
fiftyone.server.inputs

fiftyone.server.inputs.html

Module

Module

PUBLIC

FiftyOne Server shared GraphQL input types.
fiftyone.server.interfaces

fiftyone.server.interfaces.html

Module

Module

PUBLIC

FiftyOne Server interfaces
fiftyone.server.lightning

fiftyone.server.lightning.html

Module

Module

PUBLIC

FiftyOne Server lightning queries
fiftyone.server.main

fiftyone.server.main.html

Module

Module

PUBLIC

FiftyOne Server main
fiftyone.server.metadata

fiftyone.server.metadata.html

Module

Module

PUBLIC

FiftyOne Server JIT metadata utilities
fiftyone.server.mutation

fiftyone.server.mutation.html

Module

Module

PUBLIC

FiftyOne Server mutations.
fiftyone.server.paginator

fiftyone.server.paginator.html

Module

Module

PUBLIC

FiftyOne Server paginator
fiftyone.server.query

fiftyone.server.query.html

Module

Module

PUBLIC

FiftyOne Server queries.
fiftyone.server.routes

fiftyone.server.routes.html

Package

Package

PUBLIC

FiftyOne Server routes
fiftyone.server.routes.aggregate

fiftyone.server.routes.aggregate.html

Module

Module

PUBLIC

FiftyOne Server /aggregation and /tagging routes
fiftyone.server.routes.embeddings

fiftyone.server.routes.embeddings.html

Module

Module

PUBLIC

FiftyOne Server /embeddings route.
fiftyone.server.routes.event

fiftyone.server.routes.event.html

Module

Module

PUBLIC

FiftyOne Server /event route
fiftyone.server.routes.events

fiftyone.server.routes.events.html

Module

Module

PUBLIC

FiftyOne Server /events route
fiftyone.server.routes.fiftyone

fiftyone.server.routes.fiftyone.html

Module

Module

PUBLIC

FiftyOne Server /fiftyone route
fiftyone.server.routes.frames

fiftyone.server.routes.frames.html

Module

Module

PUBLIC

FiftyOne Server /frames route
fiftyone.server.routes.media

fiftyone.server.routes.media.html

Module

Module

PUBLIC

FiftyOne Server /media route
fiftyone.server.routes.plugins

fiftyone.server.routes.plugins.html

Module

Module

PUBLIC

FiftyOne Server /plugins route.
fiftyone.server.routes.screenshot

fiftyone.server.routes.screenshot.html

Module

Module

PUBLIC

FiftyOne Server /screenshot route
fiftyone.server.routes.sort

fiftyone.server.routes.sort.html

Module

Module

PUBLIC

FiftyOne Server /sort route
fiftyone.server.routes.tag

fiftyone.server.routes.tag.html

Module

Module

PUBLIC

FiftyOne Server /tag route
fiftyone.server.routes.tagging

fiftyone.server.routes.tagging.html

Module

Module

PUBLIC

FiftyOne Server /tagging route
fiftyone.server.routes.values

fiftyone.server.routes.values.html

Module

Module

PUBLIC

FiftyOne Server /values route
fiftyone.server.samples

fiftyone.server.samples.html

Module

Module

PUBLIC

FiftyOne Server samples pagination
fiftyone.server.scalars

fiftyone.server.scalars.html

Module

Module

PUBLIC

FiftyOne Server GraphQL scalars
fiftyone.server.stage_definitions

fiftyone.server.stage_definitions.html

Module

Module

PUBLIC

FiftyOne Server stage definitions
fiftyone.server.stages

fiftyone.server.stages.html

Module

Module

PUBLIC

FiftyOne Server stage definitions
fiftyone.server.subscription

fiftyone.server.subscription.html

Module

Module

PUBLIC

Undocumented
fiftyone.server.tags

fiftyone.server.tags.html

Module

Module

PUBLIC

FiftyOne Server tags and tagging
fiftyone.server.utils

fiftyone.server.utils.html

Module

Module

PUBLIC

FiftyOne Server utils.
fiftyone.server.view

fiftyone.server.view.html

Module

Module

PUBLIC

FiftyOne Server view.
fiftyone.server.workspace

fiftyone.server.workspace.html

Module

Module

PUBLIC

FiftyOne Server workspace.
fiftyone.service

fiftyone.service.html

Package

Package

PUBLIC

FiftyOne service support.
fiftyone.service.ipc

fiftyone.service.ipc.html

Module

Module

PUBLIC

Inter-process communication handling.
fiftyone.service.main

fiftyone.service.main.html

Module

Module

PUBLIC

This script provides a consistent environment for services to run in. The basic architecture is:
fiftyone.service.util

fiftyone.service.util.html

Module

Module

PUBLIC

FiftyOne service utilities.
fiftyone.types

fiftyone.types.html

Package

Package

PUBLIC

FiftyOne types.
fiftyone.types.dataset_types

fiftyone.types.dataset_types.html

Module

Module

PUBLIC

FiftyOne dataset types.
fiftyone.utils

fiftyone.utils.html

Package

Package

PUBLIC

No summary
fiftyone.utils.activitynet

fiftyone.utils.activitynet.html

Module

Module

PUBLIC

Utilities for working with the ActivityNet dataset.
fiftyone.utils.annotations

fiftyone.utils.annotations.html

Module

Module

PUBLIC

Annotation utilities.
fiftyone.utils.aws

fiftyone.utils.aws.html

Module

Module

PUBLIC

Utilities for working with Amazon Web Services.
fiftyone.utils.bdd

fiftyone.utils.bdd.html

Module

Module

PUBLIC

Utilities for working with datasets in Berkeley DeepDrive (BDD) format.
fiftyone.utils.beam

fiftyone.utils.beam.html

Module

Module

PUBLIC

Apache Beam utilities.
fiftyone.utils.cityscapes

fiftyone.utils.cityscapes.html

Module

Module

PUBLIC

Utilities for working with the Cityscapes dataset.
fiftyone.utils.clip

fiftyone.utils.clip.html

Package

Package

PUBLIC

CLIP model utils.
fiftyone.utils.clip.model

fiftyone.utils.clip.model.html

Module

Module

PUBLIC

CLIP model from https://github.com/openai/CLIP.
fiftyone.utils.clip.tokenizer

fiftyone.utils.clip.tokenizer.html

Module

Module

PUBLIC

CLIP text tokenizer from https://github.com/openai/CLIP.
fiftyone.utils.clip.zoo

fiftyone.utils.clip.zoo.html

Module

Module

PUBLIC

CLIP model wrapper for the FiftyOne Model Zoo.
fiftyone.utils.coco

fiftyone.utils.coco.html

Module

Module

PUBLIC

Utilities for working with datasets in COCO format.
fiftyone.utils.csv

fiftyone.utils.csv.html

Module

Module

PUBLIC

CSV utilities.
fiftyone.utils.cvat

fiftyone.utils.cvat.html

Module

Module

PUBLIC

Utilities for working with datasets in CVAT format.
fiftyone.utils.data

fiftyone.utils.data.html

Package

Package

PUBLIC

Data utilities.
fiftyone.utils.data.base

fiftyone.utils.data.base.html

Module

Module

PUBLIC

Data utilities.
fiftyone.utils.data.converters

fiftyone.utils.data.converters.html

Module

Module

PUBLIC

Dataset format conversion utilities.
fiftyone.utils.data.exporters

fiftyone.utils.data.exporters.html

Module

Module

PUBLIC

Dataset exporters.
fiftyone.utils.data.importers

fiftyone.utils.data.importers.html

Module

Module

PUBLIC

Dataset importers.
fiftyone.utils.data.ingestors

fiftyone.utils.data.ingestors.html

Module

Module

PUBLIC

Dataset ingestors.
fiftyone.utils.data.parsers

fiftyone.utils.data.parsers.html

Module

Module

PUBLIC

Sample parsers.
fiftyone.utils.dicom

fiftyone.utils.dicom.html

Module

Module

PUBLIC

DICOM utilities.
fiftyone.utils.eta

fiftyone.utils.eta.html

Module

Module

PUBLIC

Utilities for interfacing with the ETA library.
fiftyone.utils.eval

fiftyone.utils.eval.html

Package

Package

PUBLIC

Evaluation utilities.
fiftyone.utils.eval.activitynet

fiftyone.utils.eval.activitynet.html

Module

Module

PUBLIC

ActivityNet-style temporal detection evaluation.
fiftyone.utils.eval.base

fiftyone.utils.eval.base.html

Module

Module

PUBLIC

Base evaluation methods.
fiftyone.utils.eval.classification

fiftyone.utils.eval.classification.html

Module

Module

PUBLIC

Classification evaluation.
fiftyone.utils.eval.coco

fiftyone.utils.eval.coco.html

Module

Module

PUBLIC

COCO-style detection evaluation.
fiftyone.utils.eval.detection

fiftyone.utils.eval.detection.html

Module

Module

PUBLIC

Detection evaluation.
fiftyone.utils.eval.openimages

fiftyone.utils.eval.openimages.html

Module

Module

PUBLIC

Open Images-style detection evaluation.
fiftyone.utils.eval.regression

fiftyone.utils.eval.regression.html

Module

Module

PUBLIC

Regression evaluation.
fiftyone.utils.eval.segmentation

fiftyone.utils.eval.segmentation.html

Module

Module

PUBLIC

Segmentation evaluation.
fiftyone.utils.fiw

fiftyone.utils.fiw.html

Module

Module

PUBLIC

Utilities for working with the Families in the Wild dataset.
fiftyone.utils.flash

fiftyone.utils.flash.html

Module

Module

PUBLIC

Utilities for working with Lightning Flash.
fiftyone.utils.geojson

fiftyone.utils.geojson.html

Module

Module

PUBLIC

GeoJSON utilities.
fiftyone.utils.geotiff

fiftyone.utils.geotiff.html

Module

Module

PUBLIC

GeoTIFF utilities.
fiftyone.utils.github

fiftyone.utils.github.html

Module

Module

PUBLIC

GitHub utilities.
fiftyone.utils.groups

fiftyone.utils.groups.html

Module

Module

PUBLIC

Grouped dataset utilities.
fiftyone.utils.hmdb51

fiftyone.utils.hmdb51.html

Module

Module

PUBLIC

Utilities for working with the HMDB51 dataset.
fiftyone.utils.huggingface

fiftyone.utils.huggingface.html

Module

Module

PUBLIC

Utilities for working with Hugging Face.
fiftyone.utils.image

fiftyone.utils.image.html

Module

Module

PUBLIC

Image utilities.
fiftyone.utils.imagenet

fiftyone.utils.imagenet.html

Module

Module

PUBLIC

Utilities for working with the ImageNet dataset.
fiftyone.utils.iou

fiftyone.utils.iou.html

Module

Module

PUBLIC

Intersection over union (IoU) utilities.
fiftyone.utils.kinetics

fiftyone.utils.kinetics.html

Module

Module

PUBLIC

Utilities for working with the Kinetics dataset.
fiftyone.utils.kitti

fiftyone.utils.kitti.html

Module

Module

PUBLIC

Utilities for working with datasets in KITTI format.
fiftyone.utils.labelbox

fiftyone.utils.labelbox.html

Module

Module

PUBLIC

Utilities for working with annotations in Labelbox format.
fiftyone.utils.labels

fiftyone.utils.labels.html

Module

Module

PUBLIC

Label utilities.
fiftyone.utils.labelstudio

fiftyone.utils.labelstudio.html

Module

Module

PUBLIC

Utilities for working with annotations in Label Studio.
fiftyone.utils.lfw

fiftyone.utils.lfw.html

Module

Module

PUBLIC

Utilities for working with the Labeled Faces in the Wild dataset.
fiftyone.utils.open_clip

fiftyone.utils.open_clip.html

Module

Module

PUBLIC

CLIP model wrapper for the FiftyOne Model Zoo.
fiftyone.utils.openimages

fiftyone.utils.openimages.html

Module

Module

PUBLIC

Utilities for working with the Open Images dataset.
fiftyone.utils.openlabel

fiftyone.utils.openlabel.html

Module

Module

PUBLIC

Utilities for working with datasets in OpenLABEL format.
fiftyone.utils.patches

fiftyone.utils.patches.html

Module

Module

PUBLIC

Image patch utilities.
fiftyone.utils.places

fiftyone.utils.places.html

Module

Module

PUBLIC

Utilities for working with the Places dataset.
fiftyone.utils.quickstart

fiftyone.utils.quickstart.html

Module

Module

PUBLIC

FiftyOne quickstart.
fiftyone.utils.random

fiftyone.utils.random.html

Module

Module

PUBLIC

Random sampling utilities.
fiftyone.utils.rerun

fiftyone.utils.rerun.html

Module

Module

PUBLIC

Utilities for working with Rerun.
fiftyone.utils.sam

fiftyone.utils.sam.html

Module

Module

PUBLIC

Segment Anything wrapper for the FiftyOne Model Zoo.
fiftyone.utils.sam2

fiftyone.utils.sam2.html

Module

Module

PUBLIC

Segment Anything 2 wrapper for the FiftyOne Model Zoo.
fiftyone.utils.sama

fiftyone.utils.sama.html

Module

Module

PUBLIC

Sama utilities.
fiftyone.utils.scale

fiftyone.utils.scale.html

Module

Module

PUBLIC

Utilities for working with annotations in Scale AI format.
fiftyone.utils.super_gradients

fiftyone.utils.super_gradients.html

Module

Module

PUBLIC

Utilities for working with SuperGradients.
fiftyone.utils.tf

fiftyone.utils.tf.html

Module

Module

PUBLIC

TensorFlow utilities.
fiftyone.utils.torch

fiftyone.utils.torch.html

Module

Module

PUBLIC

PyTorch utilities.
fiftyone.utils.tracking

fiftyone.utils.tracking.html

Package

Package

PUBLIC

Tracking utilities.
fiftyone.utils.tracking.deepsort

fiftyone.utils.tracking.deepsort.html

Module

Module

PUBLIC

DeepSort wrapper for FiftyOne.
fiftyone.utils.transformers

fiftyone.utils.transformers.html

Module

Module

PUBLIC

Utilities for working with Hugging Face Transformers.
fiftyone.utils.ucf101

fiftyone.utils.ucf101.html

Module

Module

PUBLIC

Utilities for working with the UCF101 dataset.
fiftyone.utils.ultralytics

fiftyone.utils.ultralytics.html

Module

Module

PUBLIC

Utilities for working with Ultralytics.
fiftyone.utils.utils3d

fiftyone.utils.utils3d.html

Module

Module

PUBLIC

3D utilities.
fiftyone.utils.video

fiftyone.utils.video.html

Module

Module

PUBLIC

Video utilities.
fiftyone.utils.voc

fiftyone.utils.voc.html

Module

Module

PUBLIC

Utilities for working with datasets in VOC format.
fiftyone.utils.yolo

fiftyone.utils.yolo.html

Module

Module

PUBLIC

Utilities for working with datasets in YOLO format.
fiftyone.utils.youtube

fiftyone.utils.youtube.html

Module

Module

PUBLIC

Utilities for working with YouTube.
fiftyone.zoo

fiftyone.zoo.html

Package

Package

PUBLIC

The FiftyOne Zoo.
fiftyone.zoo.datasets

fiftyone.zoo.datasets.html

Package

Package

PUBLIC

The FiftyOne Dataset Zoo.
fiftyone.zoo.datasets.base

fiftyone.zoo.datasets.base.html

Module

Module

PUBLIC

FiftyOne Zoo Datasets provided natively by the library.
fiftyone.zoo.datasets.tf

fiftyone.zoo.datasets.tf.html

Module

Module

PUBLIC

FiftyOne Zoo Datasets provided by tensorflow_datasets.
fiftyone.zoo.datasets.torch

fiftyone.zoo.datasets.torch.html

Module

Module

PUBLIC

FiftyOne Zoo Datasets provided by torchvision:torchvision.datasets.
fiftyone.zoo.models

fiftyone.zoo.models.html

Package

Package

PUBLIC

The FiftyOne Model Zoo.
fiftyone.zoo.models.torch

fiftyone.zoo.models.torch.html

Module

Module

PUBLIC

FiftyOne Zoo models provided by torchvision:torchvision.models.
fiftyone.logger

index.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.__path__

index.html#__path__

Attribute

Variable

PUBLIC

Undocumented
fiftyone.__public__.config

fiftyone.__public__.html#config

Attribute

Variable

PUBLIC

Undocumented
fiftyone.__public__.annotation_config

fiftyone.__public__.html#annotation_config

Attribute

Variable

PUBLIC

Undocumented
fiftyone.__public__.evaluation_config

fiftyone.__public__.html#evaluation_config

Attribute

Variable

PUBLIC

Undocumented
fiftyone.__public__.app_config

fiftyone.__public__.html#app_config

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.config.fop

fiftyone.core.config.html#fop

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.config.logger

fiftyone.core.config.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.config.Config

fiftyone.core.config.Config.html

Class

Class

PUBLIC

Base class for JSON serializable config classes.
fiftyone.core.config.Config.__repr__

fiftyone.core.config.Config.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.config.Configurable

fiftyone.core.config.Configurable.html

Class

Class

PUBLIC

Base class for classes that can be initialized with a Config instance that configures their behavior.
fiftyone.core.config.Configurable.__init__

fiftyone.core.config.Configurable.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.config.Configurable.config

fiftyone.core.config.Configurable.html#config

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.EnvConfig

fiftyone.core.config.EnvConfig.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.config.EnvConfig.__repr__

fiftyone.core.config.EnvConfig.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig

fiftyone.core.config.FiftyOneConfig.html

Class

Class

PUBLIC

FiftyOne configuration settings.
fiftyone.core.config.FiftyOneConfig.__init__

fiftyone.core.config.FiftyOneConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.database_uri

fiftyone.core.config.FiftyOneConfig.html#database_uri

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.database_validation

fiftyone.core.config.FiftyOneConfig.html#database_validation

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.database_admin

fiftyone.core.config.FiftyOneConfig.html#database_admin

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.database_dir

fiftyone.core.config.FiftyOneConfig.html#database_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.database_name

fiftyone.core.config.FiftyOneConfig.html#database_name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.dataset_zoo_dir

fiftyone.core.config.FiftyOneConfig.html#dataset_zoo_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.model_zoo_dir

fiftyone.core.config.FiftyOneConfig.html#model_zoo_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.module_path

fiftyone.core.config.FiftyOneConfig.html#module_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.plugins_dir

fiftyone.core.config.FiftyOneConfig.html#plugins_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.plugins_cache_enabled

fiftyone.core.config.FiftyOneConfig.html#plugins_cache_enabled

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.operator_timeout

fiftyone.core.config.FiftyOneConfig.html#operator_timeout

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.allow_legacy_orchestrators

fiftyone.core.config.FiftyOneConfig.html#allow_legacy_orchestrators

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.dataset_zoo_manifest_paths

fiftyone.core.config.FiftyOneConfig.html#dataset_zoo_manifest_paths

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.model_zoo_manifest_paths

fiftyone.core.config.FiftyOneConfig.html#model_zoo_manifest_paths

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.default_dataset_dir

fiftyone.core.config.FiftyOneConfig.html#default_dataset_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.default_ml_backend

fiftyone.core.config.FiftyOneConfig.html#default_ml_backend

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.default_batch_size

fiftyone.core.config.FiftyOneConfig.html#default_batch_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.default_batcher

fiftyone.core.config.FiftyOneConfig.html#default_batcher

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.batcher_static_size

fiftyone.core.config.FiftyOneConfig.html#batcher_static_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.batcher_target_size_bytes

fiftyone.core.config.FiftyOneConfig.html#batcher_target_size_bytes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.batcher_target_latency

fiftyone.core.config.FiftyOneConfig.html#batcher_target_latency

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.default_sequence_idx

fiftyone.core.config.FiftyOneConfig.html#default_sequence_idx

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.default_image_ext

fiftyone.core.config.FiftyOneConfig.html#default_image_ext

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.default_video_ext

fiftyone.core.config.FiftyOneConfig.html#default_video_ext

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.default_app_port

fiftyone.core.config.FiftyOneConfig.html#default_app_port

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.default_app_address

fiftyone.core.config.FiftyOneConfig.html#default_app_address

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.logging_level

fiftyone.core.config.FiftyOneConfig.html#logging_level

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig._show_progress_bars

fiftyone.core.config.FiftyOneConfig.html#_show_progress_bars

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.config.FiftyOneConfig.do_not_track

fiftyone.core.config.FiftyOneConfig.html#do_not_track

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.requirement_error_level

fiftyone.core.config.FiftyOneConfig.html#requirement_error_level

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.timezone

fiftyone.core.config.FiftyOneConfig.html#timezone

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.max_thread_pool_workers

fiftyone.core.config.FiftyOneConfig.html#max_thread_pool_workers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.max_process_pool_workers

fiftyone.core.config.FiftyOneConfig.html#max_process_pool_workers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.show_progress_bars 0

fiftyone.core.config.FiftyOneConfig.html#show_progress_bars%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.show_progress_bars

fiftyone.core.config.FiftyOneConfig.html#show_progress_bars

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.show_progress_bars.setter

fiftyone.core.config.FiftyOneConfig.html#show_progress_bars.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig.attributes

fiftyone.core.config.FiftyOneConfig.html#attributes

Function

Method

PUBLIC

Undocumented
fiftyone.core.config.FiftyOneConfig._init

fiftyone.core.config.FiftyOneConfig.html#_init

Function

Method

PRIVATE

Undocumented
fiftyone.core.config.FiftyOneConfigError

fiftyone.core.config.FiftyOneConfigError.html

Class

Class

PUBLIC

Exception raised when a FiftyOne configuration issue is encountered.
fiftyone.core.config.AppConfig

fiftyone.core.config.AppConfig.html

Class

Class

PUBLIC

FiftyOne App configuration settings.
fiftyone.core.config.AppConfig.__init__

fiftyone.core.config.AppConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.color_by

fiftyone.core.config.AppConfig.html#color_by

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.color_pool

fiftyone.core.config.AppConfig.html#color_pool

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.colorscale

fiftyone.core.config.AppConfig.html#colorscale

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.grid_zoom

fiftyone.core.config.AppConfig.html#grid_zoom

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.enable_query_performance

fiftyone.core.config.AppConfig.html#enable_query_performance

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.default_query_performance

fiftyone.core.config.AppConfig.html#default_query_performance

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.loop_videos

fiftyone.core.config.AppConfig.html#loop_videos

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.media_fallback

fiftyone.core.config.AppConfig.html#media_fallback

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.disable_frame_filtering

fiftyone.core.config.AppConfig.html#disable_frame_filtering

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.multicolor_keypoints

fiftyone.core.config.AppConfig.html#multicolor_keypoints

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.notebook_height

fiftyone.core.config.AppConfig.html#notebook_height

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.proxy_url

fiftyone.core.config.AppConfig.html#proxy_url

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.show_confidence

fiftyone.core.config.AppConfig.html#show_confidence

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.show_index

fiftyone.core.config.AppConfig.html#show_index

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.show_label

fiftyone.core.config.AppConfig.html#show_label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.show_skeletons

fiftyone.core.config.AppConfig.html#show_skeletons

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.show_tooltip

fiftyone.core.config.AppConfig.html#show_tooltip

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.theme

fiftyone.core.config.AppConfig.html#theme

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.use_frame_number

fiftyone.core.config.AppConfig.html#use_frame_number

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.plugins

fiftyone.core.config.AppConfig.html#plugins

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AppConfig.get_colormap

fiftyone.core.config.AppConfig.html#get_colormap

Function

Method

PUBLIC

Generates a continuous colormap with the specified number of colors from the given colorscale.
fiftyone.core.config.AppConfig._init

fiftyone.core.config.AppConfig.html#_init

Function

Method

PRIVATE

Undocumented
fiftyone.core.config.AppConfigError

fiftyone.core.config.AppConfigError.html

Class

Class

PUBLIC

Exception raised when an invalid AppConfig instance is encountered.
fiftyone.core.config.AnnotationConfig

fiftyone.core.config.AnnotationConfig.html

Class

Class

PUBLIC

FiftyOne annotation configuration settings.
fiftyone.core.config.AnnotationConfig._BUILTIN_BACKENDS

fiftyone.core.config.AnnotationConfig.html#_BUILTIN_BACKENDS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.config.AnnotationConfig.__init__

fiftyone.core.config.AnnotationConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.config.AnnotationConfig.default_backend

fiftyone.core.config.AnnotationConfig.html#default_backend

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AnnotationConfig.backends

fiftyone.core.config.AnnotationConfig.html#backends

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.AnnotationConfig._parse_backends

fiftyone.core.config.AnnotationConfig.html#_parse_backends

Function

Method

PRIVATE

Undocumented
fiftyone.core.config.EvaluationConfig

fiftyone.core.config.EvaluationConfig.html

Class

Class

PUBLIC

FiftyOne evaluation configuration settings.
fiftyone.core.config.EvaluationConfig._BUILTIN_BACKENDS

fiftyone.core.config.EvaluationConfig.html#_BUILTIN_BACKENDS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.config.EvaluationConfig.__init__

fiftyone.core.config.EvaluationConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.config.EvaluationConfig.default_regression_backend

fiftyone.core.config.EvaluationConfig.html#default_regression_backend

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.EvaluationConfig.default_classification_backend

fiftyone.core.config.EvaluationConfig.html#default_classification_backend

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.EvaluationConfig.default_detection_backend

fiftyone.core.config.EvaluationConfig.html#default_detection_backend

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.EvaluationConfig.default_segmentation_backend

fiftyone.core.config.EvaluationConfig.html#default_segmentation_backend

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.EvaluationConfig.regression_backends

fiftyone.core.config.EvaluationConfig.html#regression_backends

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.EvaluationConfig.classification_backends

fiftyone.core.config.EvaluationConfig.html#classification_backends

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.EvaluationConfig.detection_backends

fiftyone.core.config.EvaluationConfig.html#detection_backends

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.EvaluationConfig.segmentation_backends

fiftyone.core.config.EvaluationConfig.html#segmentation_backends

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.config.EvaluationConfig._parse_backends

fiftyone.core.config.EvaluationConfig.html#_parse_backends

Function

Method

PRIVATE

Undocumented
fiftyone.core.config.locate_config

fiftyone.core.config.html#locate_config

Function

Function

PUBLIC

Returns the path to the FiftyOneConfig on disk.
fiftyone.core.config.locate_app_config

fiftyone.core.config.html#locate_app_config

Function

Function

PUBLIC

Returns the path to the AppConfig on disk.
fiftyone.core.config.locate_annotation_config

fiftyone.core.config.html#locate_annotation_config

Function

Function

PUBLIC

Returns the path to the AnnotationConfig on disk.
fiftyone.core.config.locate_evaluation_config

fiftyone.core.config.html#locate_evaluation_config

Function

Function

PUBLIC

Returns the path to the EvaluationConfig on disk.
fiftyone.core.config.load_config

fiftyone.core.config.html#load_config

Function

Function

PUBLIC

Loads the FiftyOne config.
fiftyone.core.config.load_app_config

fiftyone.core.config.html#load_app_config

Function

Function

PUBLIC

Loads the FiftyOne App config.
fiftyone.core.config.load_annotation_config

fiftyone.core.config.html#load_annotation_config

Function

Function

PUBLIC

Loads the FiftyOne annotation config.
fiftyone.core.config.load_evaluation_config

fiftyone.core.config.html#load_evaluation_config

Function

Function

PUBLIC

Loads the FiftyOne evaluation config.
fiftyone.core.config._parse_env_value

fiftyone.core.config.html#_parse_env_value

Function

Function

PRIVATE

Undocumented
fiftyone.core.config._get_installed_packages

fiftyone.core.config.html#_get_installed_packages

Function

Function

PRIVATE

Undocumented
fiftyone.core.config._set_nested_dict_value

fiftyone.core.config.html#_set_nested_dict_value

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database.foa

fiftyone.core.odm.database.html#foa

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.odm.database.fob

fiftyone.core.odm.database.html#fob

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.odm.database.fod

fiftyone.core.odm.database.html#fod

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.odm.database.foe

fiftyone.core.odm.database.html#foe

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.odm.database.fors

fiftyone.core.odm.database.html#fors

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.odm.database.logger

fiftyone.core.odm.database.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.odm.database._client

fiftyone.core.odm.database.html#_client

Attribute

Variable

PRIVATE

Undocumented
fiftyone.core.odm.database._async_client

fiftyone.core.odm.database.html#_async_client

Attribute

Variable

PRIVATE

Undocumented
fiftyone.core.odm.database._connection_kwargs

fiftyone.core.odm.database.html#_connection_kwargs

Attribute

Variable

PRIVATE

Undocumented
fiftyone.core.odm.database._db_service

fiftyone.core.odm.database.html#_db_service

Attribute

Variable

PRIVATE

Undocumented
fiftyone.core.odm.database.DatabaseConfigDocument

fiftyone.core.odm.database.DatabaseConfigDocument.html

Class

Class

PUBLIC

Backing document for the database config.
fiftyone.core.odm.database.DatabaseConfigDocument.version

fiftyone.core.odm.database.DatabaseConfigDocument.html#version

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.database.DatabaseConfigDocument.type

fiftyone.core.odm.database.DatabaseConfigDocument.html#type

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.database.DatabaseConfigDocument.__init__

fiftyone.core.odm.database.DatabaseConfigDocument.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.database.DatabaseConfigDocument._conn

fiftyone.core.odm.database.DatabaseConfigDocument.html#_conn

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.odm.database.DatabaseConfigDocument.save

fiftyone.core.odm.database.DatabaseConfigDocument.html#save

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.database.get_db_config

fiftyone.core.odm.database.html#get_db_config

Function

Function

PUBLIC

Retrieves the database config.
fiftyone.core.odm.database._handle_multiple_config_docs

fiftyone.core.odm.database.html#_handle_multiple_config_docs

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database.establish_db_conn

fiftyone.core.odm.database.html#establish_db_conn

Function

Function

PUBLIC

Establishes the database connection.
fiftyone.core.odm.database._connect

fiftyone.core.odm.database.html#_connect

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database._async_connect

fiftyone.core.odm.database.html#_async_connect

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database._delete_non_persistent_datasets_if_allowed

fiftyone.core.odm.database.html#_delete_non_persistent_datasets_if_allowed

Function

Function

PRIVATE

Deletes all non-persistent datasets if and only if we are the only client currently connected to the database.
fiftyone.core.odm.database._validate_db_version

fiftyone.core.odm.database.html#_validate_db_version

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database.aggregate

fiftyone.core.odm.database.html#aggregate

Function

Function

PUBLIC

Executes one or more aggregations on a collection.
fiftyone.core.odm.database._do_pooled_aggregate

fiftyone.core.odm.database.html#_do_pooled_aggregate

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database._do_async_pooled_aggregate

fiftyone.core.odm.database.html#_do_async_pooled_aggregate

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database._do_async_aggregate

fiftyone.core.odm.database.html#_do_async_aggregate

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database.ensure_connection

fiftyone.core.odm.database.html#ensure_connection

Function

Function

PUBLIC

Ensures database connection exists
fiftyone.core.odm.database.get_db_client

fiftyone.core.odm.database.html#get_db_client

Function

Function

PUBLIC

Returns a database client.
fiftyone.core.odm.database.get_db_conn

fiftyone.core.odm.database.html#get_db_conn

Function

Function

PUBLIC

Returns a connection to the database.
fiftyone.core.odm.database.get_async_db_client

fiftyone.core.odm.database.html#get_async_db_client

Function

Function

PUBLIC

Returns an async database client.
fiftyone.core.odm.database.get_async_db_conn

fiftyone.core.odm.database.html#get_async_db_conn

Function

Function

PUBLIC

Returns an async connection to the database.
fiftyone.core.odm.database._apply_options

fiftyone.core.odm.database.html#_apply_options

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database.drop_database

fiftyone.core.odm.database.html#drop_database

Function

Function

PUBLIC

Drops the database.
fiftyone.core.odm.database.sync_database

fiftyone.core.odm.database.html#sync_database

Function

Function

PUBLIC

Syncs all pending database writes to disk.
fiftyone.core.odm.database.list_collections

fiftyone.core.odm.database.html#list_collections

Function

Function

PUBLIC

Returns a list of all collection names in the database.
fiftyone.core.odm.database.drop_collection

fiftyone.core.odm.database.html#drop_collection

Function

Function

PUBLIC

Drops specified collection from the database.
fiftyone.core.odm.database.drop_orphan_collections

fiftyone.core.odm.database.html#drop_orphan_collections

Function

Function

PUBLIC

Drops all orphan collections from the database.
fiftyone.core.odm.database.drop_orphan_saved_views

fiftyone.core.odm.database.html#drop_orphan_saved_views

Function

Function

PUBLIC

Drops all orphan saved views from the database.
fiftyone.core.odm.database.drop_orphan_runs

fiftyone.core.odm.database.html#drop_orphan_runs

Function

Function

PUBLIC

Drops all orphan runs from the database.
fiftyone.core.odm.database.drop_orphan_stores

fiftyone.core.odm.database.html#drop_orphan_stores

Function

Function

PUBLIC

Drops all orphan execution stores from the database.
fiftyone.core.odm.database.stream_collection

fiftyone.core.odm.database.html#stream_collection

Function

Function

PUBLIC

Streams the contents of the collection to stdout.
fiftyone.core.odm.database.get_collection_stats

fiftyone.core.odm.database.html#get_collection_stats

Function

Function

PUBLIC

Sets stats about the collection.
fiftyone.core.odm.database.count_documents

fiftyone.core.odm.database.html#count_documents

Function

Function

PUBLIC

Undocumented
fiftyone.core.odm.database.export_document

fiftyone.core.odm.database.html#export_document

Function

Function

PUBLIC

Exports the document to disk in JSON format.
fiftyone.core.odm.database.export_collection

fiftyone.core.odm.database.html#export_collection

Function

Function

PUBLIC

Exports the collection to disk in JSON format.
fiftyone.core.odm.database._export_collection_single

fiftyone.core.odm.database.html#_export_collection_single

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database._export_collection_multi

fiftyone.core.odm.database.html#_export_collection_multi

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database.import_document

fiftyone.core.odm.database.html#import_document

Function

Function

PUBLIC

Imports a document from JSON on disk.
fiftyone.core.odm.database.import_collection

fiftyone.core.odm.database.html#import_collection

Function

Function

PUBLIC

Imports the collection from JSON on disk.
fiftyone.core.odm.database._import_collection_single

fiftyone.core.odm.database.html#_import_collection_single

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database._import_collection_multi

fiftyone.core.odm.database.html#_import_collection_multi

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database.insert_documents

fiftyone.core.odm.database.html#insert_documents

Function

Function

PUBLIC

Inserts documents into a collection.
fiftyone.core.odm.database.bulk_write

fiftyone.core.odm.database.html#bulk_write

Function

Function

PUBLIC

Performs a batch of write operations on a collection.
fiftyone.core.odm.database.list_datasets

fiftyone.core.odm.database.html#list_datasets

Function

Function

PUBLIC

Returns the list of available FiftyOne datasets.
fiftyone.core.odm.database._patch_referenced_docs

fiftyone.core.odm.database.html#_patch_referenced_docs

Function

Function

PRIVATE

Ensures that the referenced documents in the collection for the given dataset exactly match the IDs in its dataset document.
fiftyone.core.odm.database.patch_saved_views

fiftyone.core.odm.database.html#patch_saved_views

Function

Function

PUBLIC

Ensures that the saved view documents in the views collection for the given dataset exactly match the IDs in its dataset document.
fiftyone.core.odm.database.patch_workspaces

fiftyone.core.odm.database.html#patch_workspaces

Function

Function

PUBLIC

Ensures that the workspace documents in the workspaces collection for the given dataset exactly match the IDs in its dataset document.
fiftyone.core.odm.database.patch_annotation_runs

fiftyone.core.odm.database.html#patch_annotation_runs

Function

Function

PUBLIC

Ensures that the annotation runs in the runs collection for the given dataset exactly match the values in its dataset document.
fiftyone.core.odm.database.patch_brain_runs

fiftyone.core.odm.database.html#patch_brain_runs

Function

Function

PUBLIC

Ensures that the brain method runs in the runs collection for the given dataset exactly match the values in its dataset document.
fiftyone.core.odm.database.patch_evaluations

fiftyone.core.odm.database.html#patch_evaluations

Function

Function

PUBLIC

Ensures that the evaluation runs in the runs collection for the given dataset exactly match the values in its dataset document.
fiftyone.core.odm.database.patch_runs

fiftyone.core.odm.database.html#patch_runs

Function

Function

PUBLIC

Ensures that the runs in the runs collection for the given dataset exactly match the values in its dataset document.
fiftyone.core.odm.database._patch_runs

fiftyone.core.odm.database.html#_patch_runs

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database.delete_dataset

fiftyone.core.odm.database.html#delete_dataset

Function

Function

PUBLIC

Deletes the dataset with the given name.
fiftyone.core.odm.database.delete_saved_view

fiftyone.core.odm.database.html#delete_saved_view

Function

Function

PUBLIC

Deletes the saved view with the given name from the dataset with the given name.
fiftyone.core.odm.database.delete_saved_views

fiftyone.core.odm.database.html#delete_saved_views

Function

Function

PUBLIC

Deletes all saved views from the dataset with the given name.
fiftyone.core.odm.database.delete_annotation_run

fiftyone.core.odm.database.html#delete_annotation_run

Function

Function

PUBLIC

Deletes the annotation run with the given key from the dataset with the given name.
fiftyone.core.odm.database.delete_annotation_runs

fiftyone.core.odm.database.html#delete_annotation_runs

Function

Function

PUBLIC

Deletes all annotation runs from the dataset with the given name.
fiftyone.core.odm.database.delete_brain_run

fiftyone.core.odm.database.html#delete_brain_run

Function

Function

PUBLIC

Deletes the brain method run with the given key from the dataset with the given name.
fiftyone.core.odm.database.delete_brain_runs

fiftyone.core.odm.database.html#delete_brain_runs

Function

Function

PUBLIC

Deletes all brain method runs from the dataset with the given name.
fiftyone.core.odm.database.delete_evaluation

fiftyone.core.odm.database.html#delete_evaluation

Function

Function

PUBLIC

Deletes the evaluation run with the given key from the dataset with the given name.
fiftyone.core.odm.database.delete_evaluations

fiftyone.core.odm.database.html#delete_evaluations

Function

Function

PUBLIC

Deletes all evaluations from the dataset with the given name.
fiftyone.core.odm.database.delete_run

fiftyone.core.odm.database.html#delete_run

Function

Function

PUBLIC

Deletes the run with the given key from the dataset with the given name.
fiftyone.core.odm.database.delete_runs

fiftyone.core.odm.database.html#delete_runs

Function

Function

PUBLIC

Deletes all runs from the dataset with the given name.
fiftyone.core.odm.database._get_logger

fiftyone.core.odm.database.html#_get_logger

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database._DryRunLoggerAdapter

fiftyone.core.odm.database._DryRunLoggerAdapter.html

Class

Class

PRIVATE

Undocumented
fiftyone.core.odm.database._DryRunLoggerAdapter.process

fiftyone.core.odm.database._DryRunLoggerAdapter.html#process

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.database._delete_run

fiftyone.core.odm.database.html#_delete_run

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database._delete_runs

fiftyone.core.odm.database.html#_delete_runs

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database._get_saved_view_ids

fiftyone.core.odm.database.html#_get_saved_view_ids

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database._get_run_ids

fiftyone.core.odm.database.html#_get_run_ids

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database._get_result_ids

fiftyone.core.odm.database.html#_get_result_ids

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database._delete_saved_views

fiftyone.core.odm.database.html#_delete_saved_views

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database._delete_run_docs

fiftyone.core.odm.database.html#_delete_run_docs

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database._delete_run_results

fiftyone.core.odm.database.html#_delete_run_results

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database._delete_stores

fiftyone.core.odm.database.html#_delete_stores

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.database._RUNS_FIELDS

fiftyone.core.odm.database.html#_RUNS_FIELDS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.odm.utils.fol

fiftyone.core.odm.utils.html#fol

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.odm.utils.food

fiftyone.core.odm.utils.html#food

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.odm.utils.fooe

fiftyone.core.odm.utils.html#fooe

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.odm.utils.serialize_value

fiftyone.core.odm.utils.html#serialize_value

Function

Function

PUBLIC

Serializes the given value.
fiftyone.core.odm.utils.deserialize_value

fiftyone.core.odm.utils.html#deserialize_value

Function

Function

PUBLIC

Deserializes the given value.
fiftyone.core.odm.utils.validate_field_name

fiftyone.core.odm.utils.html#validate_field_name

Function

Function

PUBLIC

Verifies that the given field name is valid.
fiftyone.core.odm.utils.create_field

fiftyone.core.odm.utils.html#create_field

Function

Function

PUBLIC

Creates the field defined by the given specification.
fiftyone.core.odm.utils.create_implied_field

fiftyone.core.odm.utils.html#create_implied_field

Function

Function

PUBLIC

Creates the field for the given value.
fiftyone.core.odm.utils.get_field_kwargs

fiftyone.core.odm.utils.html#get_field_kwargs

Function

Function

PUBLIC

Constructs the field keyword arguments dictionary for the given field.
fiftyone.core.odm.utils._parse_field_str

fiftyone.core.odm.utils.html#_parse_field_str

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.utils.get_implied_field_kwargs

fiftyone.core.odm.utils.html#get_implied_field_kwargs

Function

Function

PUBLIC

Infers the field keyword arguments dictionary for a field that can hold the given value.
fiftyone.core.odm.utils._get_field_kwargs

fiftyone.core.odm.utils.html#_get_field_kwargs

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.utils._parse_embedded_doc_fields

fiftyone.core.odm.utils.html#_parse_embedded_doc_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.utils._parse_embedded_doc_list_fields

fiftyone.core.odm.utils.html#_parse_embedded_doc_list_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.utils._merge_embedded_doc_fields

fiftyone.core.odm.utils.html#_merge_embedded_doc_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.utils._finalize_embedded_doc_fields

fiftyone.core.odm.utils.html#_finalize_embedded_doc_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.utils.validate_fields_match

fiftyone.core.odm.utils.html#validate_fields_match

Function

Function

PUBLIC

Validates that the types of the given fields match.
fiftyone.core.odm.utils._get_field_type

fiftyone.core.odm.utils.html#_get_field_type

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.utils._get_list_subfield_type

fiftyone.core.odm.utils.html#_get_list_subfield_type

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.utils.DocumentRegistry

fiftyone.core.odm.utils.DocumentRegistry.html

Class

Class

PUBLIC

A registry of fiftyone.core.odm.document.MongoEngineBaseDocument classes found when importing data from the database.
fiftyone.core.odm.utils.DocumentRegistry.__init__

fiftyone.core.odm.utils.DocumentRegistry.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.utils.DocumentRegistry._cache

fiftyone.core.odm.utils.DocumentRegistry.html#_cache

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.odm.utils.DocumentRegistry.__repr__

fiftyone.core.odm.utils.DocumentRegistry.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.utils.DocumentRegistry.__getitem__

fiftyone.core.odm.utils.DocumentRegistry.html#__getitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.utils.DocumentRegistry._get_cls

fiftyone.core.odm.utils.DocumentRegistry.html#_get_cls

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.utils.DocumentRegistryError

fiftyone.core.odm.utils.DocumentRegistryError.html

Class

Exception

PUBLIC

Error raised when an unknown document class is encountered.
fiftyone.core.odm.utils._document_registry

fiftyone.core.odm.utils.html#_document_registry

Attribute

Variable

PRIVATE

Undocumented
fiftyone.core.odm.utils.load_dataset

fiftyone.core.odm.utils.html#load_dataset

Function

Function

PUBLIC

Loads the dataset from the database by its unique id or name. Throws an error if neither id nor name is provided.
fiftyone.core.odm.document.SerializableDocument

fiftyone.core.odm.document.SerializableDocument.html

Class

Class

PUBLIC

Mixin for documents that can be serialized in BSON or JSON format.
fiftyone.core.odm.document.SerializableDocument.__str__

fiftyone.core.odm.document.SerializableDocument.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.document.SerializableDocument.__repr__

fiftyone.core.odm.document.SerializableDocument.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.document.SerializableDocument.__eq__

fiftyone.core.odm.document.SerializableDocument.html#__eq__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.document.SerializableDocument.field_names

fiftyone.core.odm.document.SerializableDocument.html#field_names

Attribute

Property

PUBLIC

An ordered tuple of the public fields of this document.
fiftyone.core.odm.document.SerializableDocument.fancy_repr

fiftyone.core.odm.document.SerializableDocument.html#fancy_repr

Function

Method

PUBLIC

Generates a customizable string representation of the document.
fiftyone.core.odm.document.SerializableDocument.has_field

fiftyone.core.odm.document.SerializableDocument.html#has_field

Function

Method

PUBLIC

Determines whether the document has a field of the given name.
fiftyone.core.odm.document.SerializableDocument.get_field

fiftyone.core.odm.document.SerializableDocument.html#get_field

Function

Method

PUBLIC

Gets the field of the document.
fiftyone.core.odm.document.SerializableDocument.set_field

fiftyone.core.odm.document.SerializableDocument.html#set_field

Function

Method

PUBLIC

Sets the value of a field of the document.
fiftyone.core.odm.document.SerializableDocument.clear_field

fiftyone.core.odm.document.SerializableDocument.html#clear_field

Function

Method

PUBLIC

Clears the field from the document.
fiftyone.core.odm.document.SerializableDocument.iter_fields

fiftyone.core.odm.document.SerializableDocument.html#iter_fields

Function

Method

PUBLIC

Returns an iterator over the (name, value) pairs of the public fields of the document.
fiftyone.core.odm.document.SerializableDocument._get_field_names

fiftyone.core.odm.document.SerializableDocument.html#_get_field_names

Function

Method

PRIVATE

Returns an ordered tuple of field names of this document.
fiftyone.core.odm.document.SerializableDocument._get_repr_fields

fiftyone.core.odm.document.SerializableDocument.html#_get_repr_fields

Function

Method

PRIVATE

Returns an ordered tuple of field names that should be included in the repr of the document.
fiftyone.core.odm.document.SerializableDocument.copy

fiftyone.core.odm.document.SerializableDocument.html#copy

Function

Method

PUBLIC

Returns a deep copy of the document.
fiftyone.core.odm.document.SerializableDocument.merge

fiftyone.core.odm.document.SerializableDocument.html#merge

Function

Method

PUBLIC

Merges the contents of the given document into this document.
fiftyone.core.odm.document.SerializableDocument.to_dict

fiftyone.core.odm.document.SerializableDocument.html#to_dict

Function

Method

PUBLIC

Serializes this document to a BSON/JSON dictionary.
fiftyone.core.odm.document.SerializableDocument.from_dict

fiftyone.core.odm.document.SerializableDocument.html#from_dict

Function

Class Method

PUBLIC

Loads the document from a BSON/JSON dictionary.
fiftyone.core.odm.document.SerializableDocument.to_json

fiftyone.core.odm.document.SerializableDocument.html#to_json

Function

Method

PUBLIC

Serializes the document to a JSON string.
fiftyone.core.odm.document.SerializableDocument.from_json

fiftyone.core.odm.document.SerializableDocument.html#from_json

Function

Class Method

PUBLIC

Loads the document from a JSON string.
fiftyone.core.odm.document.MongoEngineBaseDocument

fiftyone.core.odm.document.MongoEngineBaseDocument.html

Class

Class

PUBLIC

Mixin for all mongoengine:mongoengine.base.BaseDocument subclasses that implements the SerializableDocument interface.
fiftyone.core.odm.document.MongoEngineBaseDocument.__delattr__

fiftyone.core.odm.document.MongoEngineBaseDocument.html#__delattr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.document.MongoEngineBaseDocument.__delitem__

fiftyone.core.odm.document.MongoEngineBaseDocument.html#__delitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.document.MongoEngineBaseDocument.__deepcopy__

fiftyone.core.odm.document.MongoEngineBaseDocument.html#__deepcopy__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.document.MongoEngineBaseDocument.field_names

fiftyone.core.odm.document.MongoEngineBaseDocument.html#field_names

Attribute

Property

PUBLIC

An ordered tuple of the public fields of this document.
fiftyone.core.odm.document.MongoEngineBaseDocument.has_field

fiftyone.core.odm.document.MongoEngineBaseDocument.html#has_field

Function

Method

PUBLIC

Determines whether the document has a field of the given name.
fiftyone.core.odm.document.MongoEngineBaseDocument.get_field

fiftyone.core.odm.document.MongoEngineBaseDocument.html#get_field

Function

Method

PUBLIC

Gets the field of the document.
fiftyone.core.odm.document.MongoEngineBaseDocument._get_field

fiftyone.core.odm.document.MongoEngineBaseDocument.html#_get_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.document.MongoEngineBaseDocument.set_field

fiftyone.core.odm.document.MongoEngineBaseDocument.html#set_field

Function

Method

PUBLIC

Sets the value of a field of the document.
fiftyone.core.odm.document.MongoEngineBaseDocument.clear_field

fiftyone.core.odm.document.MongoEngineBaseDocument.html#clear_field

Function

Method

PUBLIC

Clears the field from the document.
fiftyone.core.odm.document.MongoEngineBaseDocument._fields_ordered

fiftyone.core.odm.document.MongoEngineBaseDocument.html#_fields_ordered

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.odm.document.MongoEngineBaseDocument.field_to_mongo

fiftyone.core.odm.document.MongoEngineBaseDocument.html#field_to_mongo

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.document.MongoEngineBaseDocument.field_to_python

fiftyone.core.odm.document.MongoEngineBaseDocument.html#field_to_python

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.document.MongoEngineBaseDocument._get_field_names

fiftyone.core.odm.document.MongoEngineBaseDocument.html#_get_field_names

Function

Method

PRIVATE

Returns an ordered tuple of field names of this document.
fiftyone.core.odm.document.MongoEngineBaseDocument._to_db_fields

fiftyone.core.odm.document.MongoEngineBaseDocument.html#_to_db_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.document.MongoEngineBaseDocument._get_repr_fields

fiftyone.core.odm.document.MongoEngineBaseDocument.html#_get_repr_fields

Function

Method

PRIVATE

Returns an ordered tuple of field names that should be included in the repr of the document.
fiftyone.core.odm.document.MongoEngineBaseDocument.to_dict

fiftyone.core.odm.document.MongoEngineBaseDocument.html#to_dict

Function

Method

PUBLIC

Serializes this document to a BSON/JSON dictionary.
fiftyone.core.odm.document.MongoEngineBaseDocument.from_dict

fiftyone.core.odm.document.MongoEngineBaseDocument.html#from_dict

Function

Class Method

PUBLIC

Loads the document from a BSON/JSON dictionary.
fiftyone.core.odm.document.DynamicMixin

fiftyone.core.odm.document.DynamicMixin.html

Class

Class

PUBLIC

Mixin for MongoEngineBaseDocument classes that can have arbitrary dynamic fields added to them.
fiftyone.core.odm.document.DynamicMixin.to_mongo

fiftyone.core.odm.document.DynamicMixin.html#to_mongo

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.document.DynamicMixin._from_son

fiftyone.core.odm.document.DynamicMixin.html#_from_son

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.document.BaseDocument

fiftyone.core.odm.document.BaseDocument.html

Class

Class

PUBLIC

Base class for documents that are written to the database in their own collections.
fiftyone.core.odm.document.BaseDocument.id

fiftyone.core.odm.document.BaseDocument.html#id

Attribute

Instance Variable

PUBLIC

the ID of the document, or None if it has not been added to the database
fiftyone.core.odm.document.BaseDocument.__eq__

fiftyone.core.odm.document.BaseDocument.html#__eq__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.document.BaseDocument._get_repr_fields

fiftyone.core.odm.document.BaseDocument.html#_get_repr_fields

Function

Method

PRIVATE

Returns an ordered tuple of field names that should be included in the repr of the document.
fiftyone.core.odm.document.BaseDocument.in_db

fiftyone.core.odm.document.BaseDocument.html#in_db

Attribute

Property

PUBLIC

Whether the document has been inserted into the database.
fiftyone.core.odm.document.DynamicDocument

fiftyone.core.odm.document.DynamicDocument.html

Class

Class

PUBLIC

Base class for dynamic documents that are stored in a MongoDB collection.
fiftyone.core.odm.document.DynamicDocument.id

fiftyone.core.odm.document.DynamicDocument.html#id

Attribute

Instance Variable

PUBLIC

the ID of the document, or None if it has not been added to the database
fiftyone.core.odm.document.DynamicDocument.meta

fiftyone.core.odm.document.DynamicDocument.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.document.Document

fiftyone.core.odm.document.Document.html

Class

Class

PUBLIC

Base class for documents that are stored in a MongoDB collection.
fiftyone.core.odm.document.Document.id

fiftyone.core.odm.document.Document.html#id

Attribute

Instance Variable

PUBLIC

the ID of the document, or None if it has not been added to the database
fiftyone.core.odm.document.Document.meta

fiftyone.core.odm.document.Document.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.document.Document.__init__

fiftyone.core.odm.document.Document.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.document.Document._changed_fields

fiftyone.core.odm.document.Document.html#_changed_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.odm.document.Document._doc_name

fiftyone.core.odm.document.Document.html#_doc_name

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.document.Document.copy

fiftyone.core.odm.document.Document.html#copy

Function

Method

PUBLIC

Returns a deep copy of the document.
fiftyone.core.odm.document.Document.reload

fiftyone.core.odm.document.Document.html#reload

Function

Method

PUBLIC

Reloads the document from the database.
fiftyone.core.odm.document.Document.save

fiftyone.core.odm.document.Document.html#save

Function

Method

PUBLIC

Saves the document to the database.
fiftyone.core.odm.document.Document.copy_with_new_id

fiftyone.core.odm.document.Document.html#copy_with_new_id

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.document.Document._save

fiftyone.core.odm.document.Document.html#_save

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.document.Document._created

fiftyone.core.odm.document.Document.html#_created

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.odm.document.Document._insert

fiftyone.core.odm.document.Document.html#_insert

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.document.Document._update

fiftyone.core.odm.document.Document.html#_update

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.document.Document.last_modified_at

fiftyone.core.odm.document.Document.html#last_modified_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.document.Document._update_last_loaded_at

fiftyone.core.odm.document.Document.html#_update_last_loaded_at

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.document.Document.last_loaded_at

fiftyone.core.odm.document.Document.html#last_loaded_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.document.Document._do_updates

fiftyone.core.odm.document.Document.html#_do_updates

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.document.Document._deferred_updates

fiftyone.core.odm.document.Document.html#_deferred_updates

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.document.Document._parse_changed_fields

fiftyone.core.odm.document.Document.html#_parse_changed_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.document.Document._parse_db_path

fiftyone.core.odm.document.Document.html#_parse_db_path

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.document.Document._validate_updates

fiftyone.core.odm.document.Document.html#_validate_updates

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.document.Document._validate

fiftyone.core.odm.document.Document.html#_validate

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.document._merge_lists

fiftyone.core.odm.document.html#_merge_lists

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.document._merge_dicts

fiftyone.core.odm.document.html#_merge_dicts

Function

Function

PRIVATE

Undocumented
fiftyone.core.expressions.to_mongo

fiftyone.core.expressions.html#to_mongo

Function

Function

PUBLIC

Converts an expression to its MongoDB representation.
fiftyone.core.expressions.is_frames_expr

fiftyone.core.expressions.html#is_frames_expr

Function

Function

PUBLIC

Determines whether the given expression involves a "frames" field.
fiftyone.core.expressions.get_group_slices

fiftyone.core.expressions.html#get_group_slices

Function

Function

PUBLIC

Extracts the group slices from the given expression, if any.
fiftyone.core.expressions._do_get_group_slices

fiftyone.core.expressions.html#_do_get_group_slices

Function

Function

PRIVATE

Undocumented
fiftyone.core.expressions.ViewExpression

fiftyone.core.expressions.ViewExpression.html

Class

Class

PUBLIC

An expression defining a possibly-complex manipulation of a document.
fiftyone.core.expressions.ViewExpression.__init__

fiftyone.core.expressions.ViewExpression.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.expressions.ViewExpression._expr

fiftyone.core.expressions.ViewExpression.html#_expr

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.expressions.ViewExpression._prefix

fiftyone.core.expressions.ViewExpression.html#_prefix

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.expressions.ViewExpression.__str__

fiftyone.core.expressions.ViewExpression.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.expressions.ViewExpression.__repr__

fiftyone.core.expressions.ViewExpression.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.expressions.ViewExpression.__hash__

fiftyone.core.expressions.ViewExpression.html#__hash__

Function

Method

PUBLIC

Undocumented
fiftyone.core.expressions.ViewExpression.__deepcopy__

fiftyone.core.expressions.ViewExpression.html#__deepcopy__

Function

Method

PUBLIC

Undocumented
fiftyone.core.expressions.ViewExpression._freeze_prefix

fiftyone.core.expressions.ViewExpression.html#_freeze_prefix

Function

Method

PRIVATE

Undocumented
fiftyone.core.expressions.ViewExpression.is_frozen

fiftyone.core.expressions.ViewExpression.html#is_frozen

Attribute

Property

PUBLIC

Whether this expression's prefix is frozen.
fiftyone.core.expressions.ViewExpression.to_mongo

fiftyone.core.expressions.ViewExpression.html#to_mongo

Function

Method

PUBLIC

Returns a MongoDB representation of the expression.
fiftyone.core.expressions.ViewExpression.__call__

fiftyone.core.expressions.ViewExpression.html#__call__

Function

Method

PUBLIC

Retrieves the specified field or embedded field of this expression, which must resolve to a document.
fiftyone.core.expressions.ViewExpression.__eq__

fiftyone.core.expressions.ViewExpression.html#__eq__

Function

Method

PUBLIC

Determines whether this expression is equal to the given value or expression, self == other.
fiftyone.core.expressions.ViewExpression.__ne__

fiftyone.core.expressions.ViewExpression.html#__ne__

Function

Method

PUBLIC

Determines whether this expression is not equal to the given value or expression, self != other.
fiftyone.core.expressions.ViewExpression.__ge__

fiftyone.core.expressions.ViewExpression.html#__ge__

Function

Method

PUBLIC

Determines whether this expression is greater than or equal to the given value or expression, self >= other.
fiftyone.core.expressions.ViewExpression.__gt__

fiftyone.core.expressions.ViewExpression.html#__gt__

Function

Method

PUBLIC

Determines whether this expression is greater than the given value or expression, self >= other.
fiftyone.core.expressions.ViewExpression.__le__

fiftyone.core.expressions.ViewExpression.html#__le__

Function

Method

PUBLIC

Determines whether this expression is less than or equal to the given value or expression, self <= other.
fiftyone.core.expressions.ViewExpression.__lt__

fiftyone.core.expressions.ViewExpression.html#__lt__

Function

Method

PUBLIC

Determines whether this expression is less than the given value or expression, self <= other.
fiftyone.core.expressions.ViewExpression.exists

fiftyone.core.expressions.ViewExpression.html#exists

Function

Method

PUBLIC

Determines whether this expression, which must resolve to a field, exists and is not None.
fiftyone.core.expressions.ViewExpression.__invert__

fiftyone.core.expressions.ViewExpression.html#__invert__

Function

Method

PUBLIC

Inverts this expression, ~self.
fiftyone.core.expressions.ViewExpression.__and__

fiftyone.core.expressions.ViewExpression.html#__and__

Function

Method

PUBLIC

Computes the logical AND of this expression and the given value or expression, self & other.
fiftyone.core.expressions.ViewExpression.__rand__

fiftyone.core.expressions.ViewExpression.html#__rand__

Function

Method

PUBLIC

Undocumented
fiftyone.core.expressions.ViewExpression.__or__

fiftyone.core.expressions.ViewExpression.html#__or__

Function

Method

PUBLIC

Computes the logical OR of this expression and the given value or expression, self | other.
fiftyone.core.expressions.ViewExpression.__ror__

fiftyone.core.expressions.ViewExpression.html#__ror__

Function

Method

PUBLIC

Undocumented
fiftyone.core.expressions.ViewExpression.__abs__

fiftyone.core.expressions.ViewExpression.html#__abs__

Function

Method

PUBLIC

Computes the absolute value of this expression, which must resolve to a numeric value.
fiftyone.core.expressions.ViewExpression.__add__

fiftyone.core.expressions.ViewExpression.html#__add__

Function

Method

PUBLIC

Adds the given value to this expression, which must resolve to a numeric value, self + other.
fiftyone.core.expressions.ViewExpression.__ceil__

fiftyone.core.expressions.ViewExpression.html#__ceil__

Function

Method

PUBLIC

Computes the ceiling of this expression, which must resolve to a numeric value.
fiftyone.core.expressions.ViewExpression.__floor__

fiftyone.core.expressions.ViewExpression.html#__floor__

Function

Method

PUBLIC

Computes the floor of this expression, which must resolve to a numeric value.
fiftyone.core.expressions.ViewExpression.__round__

fiftyone.core.expressions.ViewExpression.html#__round__

Function

Method

PUBLIC

Rounds this expression, which must resolve to a numeric value, at the given decimal place.
fiftyone.core.expressions.ViewExpression.__mod__

fiftyone.core.expressions.ViewExpression.html#__mod__

Function

Method

PUBLIC

Computes the modulus of this expression, which must resolve to a numeric value, self % other.
fiftyone.core.expressions.ViewExpression.__mul__

fiftyone.core.expressions.ViewExpression.html#__mul__

Function

Method

PUBLIC

Computes the product of the given value and this expression, which must resolve to a numeric value, self * other.
fiftyone.core.expressions.ViewExpression.__pow__

fiftyone.core.expressions.ViewExpression.html#__pow__

Function

Method

PUBLIC

Raises this expression, which must resolve to a numeric value, to the given power, self ** power.
fiftyone.core.expressions.ViewExpression.__radd__

fiftyone.core.expressions.ViewExpression.html#__radd__

Function

Method

PUBLIC

Undocumented
fiftyone.core.expressions.ViewExpression.__rmod__

fiftyone.core.expressions.ViewExpression.html#__rmod__

Function

Method

PUBLIC

Undocumented
fiftyone.core.expressions.ViewExpression.__rmul__

fiftyone.core.expressions.ViewExpression.html#__rmul__

Function

Method

PUBLIC

Undocumented
fiftyone.core.expressions.ViewExpression.__rsub__

fiftyone.core.expressions.ViewExpression.html#__rsub__

Function

Method

PUBLIC

Undocumented
fiftyone.core.expressions.ViewExpression.__rtruediv__

fiftyone.core.expressions.ViewExpression.html#__rtruediv__

Function

Method

PUBLIC

Undocumented
fiftyone.core.expressions.ViewExpression.__sub__

fiftyone.core.expressions.ViewExpression.html#__sub__

Function

Method

PUBLIC

Subtracts the given value from this expression, which must resolve to a numeric value, self - other.
fiftyone.core.expressions.ViewExpression.__truediv__

fiftyone.core.expressions.ViewExpression.html#__truediv__

Function

Method

PUBLIC

Divides this expression, which must resolve to a numeric value, by the given value, self / other.
fiftyone.core.expressions.ViewExpression.abs

fiftyone.core.expressions.ViewExpression.html#abs

Function

Method

PUBLIC

Computes the absolute value of this expression, which must resolve to a numeric value.
fiftyone.core.expressions.ViewExpression.floor

fiftyone.core.expressions.ViewExpression.html#floor

Function

Method

PUBLIC

Computes the floor of this expression, which must resolve to a numeric value.
fiftyone.core.expressions.ViewExpression.ceil

fiftyone.core.expressions.ViewExpression.html#ceil

Function

Method

PUBLIC

Computes the ceiling of this expression, which must resolve to a numeric value.
fiftyone.core.expressions.ViewExpression.round

fiftyone.core.expressions.ViewExpression.html#round

Function

Method

PUBLIC

Rounds this expression, which must resolve to a numeric value, at the given decimal place.
fiftyone.core.expressions.ViewExpression.trunc

fiftyone.core.expressions.ViewExpression.html#trunc

Function

Method

PUBLIC

Truncates this expression, which must resolve to a numeric value, at the specified decimal place.
fiftyone.core.expressions.ViewExpression.exp

fiftyone.core.expressions.ViewExpression.html#exp

Function

Method

PUBLIC

Raises Euler's number to this expression, which must resolve to a numeric value.
fiftyone.core.expressions.ViewExpression.ln

fiftyone.core.expressions.ViewExpression.html#ln

Function

Method

PUBLIC

Computes the natural logarithm of this expression, which must resolve to a numeric value.
fiftyone.core.expressions.ViewExpression.log

fiftyone.core.expressions.ViewExpression.html#log

Function

Method

PUBLIC

Computes the logarithm base base of this expression, which must resolve to a numeric value.
fiftyone.core.expressions.ViewExpression.log10

fiftyone.core.expressions.ViewExpression.html#log10

Function

Method

PUBLIC

Computes the logarithm base 10 of this expression, which must resolve to a numeric value.
fiftyone.core.expressions.ViewExpression.pow

fiftyone.core.expressions.ViewExpression.html#pow

Function

Method

PUBLIC

Raises this expression, which must resolve to a numeric value, to the given power, self ** power.
fiftyone.core.expressions.ViewExpression.sqrt

fiftyone.core.expressions.ViewExpression.html#sqrt

Function

Method

PUBLIC

Computes the square root of this expression, which must resolve to a numeric value.
fiftyone.core.expressions.ViewExpression.cos

fiftyone.core.expressions.ViewExpression.html#cos

Function

Method

PUBLIC

Computes the cosine of this expression, which must resolve to a numeric value, in radians.
fiftyone.core.expressions.ViewExpression.cosh

fiftyone.core.expressions.ViewExpression.html#cosh

Function

Method

PUBLIC

Computes the hyperbolic cosine of this expression, which must resolve to a numeric value, in radians.
fiftyone.core.expressions.ViewExpression.sin

fiftyone.core.expressions.ViewExpression.html#sin

Function

Method

PUBLIC

Computes the sine of this expression, which must resolve to a numeric value, in radians.
fiftyone.core.expressions.ViewExpression.sinh

fiftyone.core.expressions.ViewExpression.html#sinh

Function

Method

PUBLIC

Computes the hyperbolic sine of this expression, which must resolve to a numeric value, in radians.
fiftyone.core.expressions.ViewExpression.tan

fiftyone.core.expressions.ViewExpression.html#tan

Function

Method

PUBLIC

Computes the tangent of this expression, which must resolve to a numeric value, in radians.
fiftyone.core.expressions.ViewExpression.tanh

fiftyone.core.expressions.ViewExpression.html#tanh

Function

Method

PUBLIC

Computes the hyperbolic tangent of this expression, which must resolve to a numeric value, in radians.
fiftyone.core.expressions.ViewExpression.arccos

fiftyone.core.expressions.ViewExpression.html#arccos

Function

Method

PUBLIC

Computes the inverse cosine of this expression, which must resolve to a numeric value, in radians.
fiftyone.core.expressions.ViewExpression.arccosh

fiftyone.core.expressions.ViewExpression.html#arccosh

Function

Method

PUBLIC

Computes the inverse hyperbolic cosine of this expression, which must resolve to a numeric value, in radians.
fiftyone.core.expressions.ViewExpression.arcsin

fiftyone.core.expressions.ViewExpression.html#arcsin

Function

Method

PUBLIC

Computes the inverse sine of this expression, which must resolve to a numeric value, in radians.
fiftyone.core.expressions.ViewExpression.arcsinh

fiftyone.core.expressions.ViewExpression.html#arcsinh

Function

Method

PUBLIC

Computes the inverse hyperbolic sine of this expression, which must resolve to a numeric value, in radians.
fiftyone.core.expressions.ViewExpression.arctan

fiftyone.core.expressions.ViewExpression.html#arctan

Function

Method

PUBLIC

Computes the inverse tangent of this expression, which must resolve to a numeric value, in radians.
fiftyone.core.expressions.ViewExpression.arctanh

fiftyone.core.expressions.ViewExpression.html#arctanh

Function

Method

PUBLIC

Computes the inverse hyperbolic tangent of this expression, which must resolve to a numeric value, in radians.
fiftyone.core.expressions.ViewExpression.type

fiftyone.core.expressions.ViewExpression.html#type

Function

Method

PUBLIC

Returns the type string of this expression.
fiftyone.core.expressions.ViewExpression.is_null

fiftyone.core.expressions.ViewExpression.html#is_null

Function

Method

PUBLIC

Determines whether this expression is null.
fiftyone.core.expressions.ViewExpression.is_number

fiftyone.core.expressions.ViewExpression.html#is_number

Function

Method

PUBLIC

Determines whether this expression is a number.
fiftyone.core.expressions.ViewExpression.is_string

fiftyone.core.expressions.ViewExpression.html#is_string

Function

Method

PUBLIC

Determines whether this expression is a string.
fiftyone.core.expressions.ViewExpression.is_array

fiftyone.core.expressions.ViewExpression.html#is_array

Function

Method

PUBLIC

Determines whether this expression is an array.
fiftyone.core.expressions.ViewExpression.is_missing

fiftyone.core.expressions.ViewExpression.html#is_missing

Function

Method

PUBLIC

Determines whether this expression refers to a missing field.
fiftyone.core.expressions.ViewExpression.is_in

fiftyone.core.expressions.ViewExpression.html#is_in

Function

Method

PUBLIC

Creates an expression that returns a boolean indicating whether self in values.
fiftyone.core.expressions.ViewExpression.to_bool

fiftyone.core.expressions.ViewExpression.html#to_bool

Function

Method

PUBLIC

Converts the expression to a boolean value.
fiftyone.core.expressions.ViewExpression.to_int

fiftyone.core.expressions.ViewExpression.html#to_int

Function

Method

PUBLIC

Converts the expression to an integer value.
fiftyone.core.expressions.ViewExpression.to_double

fiftyone.core.expressions.ViewExpression.html#to_double

Function

Method

PUBLIC

Converts the expression to a double precision value.
fiftyone.core.expressions.ViewExpression.to_string

fiftyone.core.expressions.ViewExpression.html#to_string

Function

Method

PUBLIC

Converts the expression to a string value.
fiftyone.core.expressions.ViewExpression.to_date

fiftyone.core.expressions.ViewExpression.html#to_date

Function

Method

PUBLIC

Converts the expression to a date value.
fiftyone.core.expressions.ViewExpression.apply

fiftyone.core.expressions.ViewExpression.html#apply

Function

Method

PUBLIC

Applies the given expression to this expression.
fiftyone.core.expressions.ViewExpression.if_else

fiftyone.core.expressions.ViewExpression.html#if_else

Function

Method

PUBLIC

Returns either true_expr or false_expr depending on the value of this expression, which must resolve to a boolean.
fiftyone.core.expressions.ViewExpression.cases

fiftyone.core.expressions.ViewExpression.html#cases

Function

Method

PUBLIC

Applies a case statement to this expression, which effectively computes the following pseudocode:
fiftyone.core.expressions.ViewExpression.switch

fiftyone.core.expressions.ViewExpression.html#switch

Function

Method

PUBLIC

Applies a switch statement to this expression, which effectively computes the given pseudocode:
fiftyone.core.expressions.ViewExpression.map_values

fiftyone.core.expressions.ViewExpression.html#map_values

Function

Method

PUBLIC

Replaces this expression with the corresponding value in the provided mapping dict, if it is present as a key.
fiftyone.core.expressions.ViewExpression.set_field

fiftyone.core.expressions.ViewExpression.html#set_field

Function

Method

PUBLIC

Sets the specified field or embedded field of this expression, which must resolve to a document, to the given value or expression.
fiftyone.core.expressions.ViewExpression.let_in

fiftyone.core.expressions.ViewExpression.html#let_in

Function

Method

PUBLIC

Returns an equivalent expression where this expression is defined as a variable that is used wherever necessary in the given expression.
fiftyone.core.expressions.ViewExpression._let_in

fiftyone.core.expressions.ViewExpression.html#_let_in

Function

Method

PRIVATE

Undocumented
fiftyone.core.expressions.ViewExpression.min

fiftyone.core.expressions.ViewExpression.html#min

Function

Method

PUBLIC

Returns the minimum value of either this expression, which must resolve to an array, or the minimum of this expression and the given value.
fiftyone.core.expressions.ViewExpression.max

fiftyone.core.expressions.ViewExpression.html#max

Function

Method

PUBLIC

Returns the maximum value of either this expression, which must resolve to an array, or the maximum of this expression and the given value.
fiftyone.core.expressions.ViewExpression.__getitem__

fiftyone.core.expressions.ViewExpression.html#__getitem__

Function

Method

PUBLIC

Returns the element or slice of this expression, which must resolve to an array.
fiftyone.core.expressions.ViewExpression.__len__

fiftyone.core.expressions.ViewExpression.html#__len__

Function

Method

PUBLIC

Undocumented
fiftyone.core.expressions.ViewExpression.length

fiftyone.core.expressions.ViewExpression.html#length

Function

Method

PUBLIC

Computes the length of this expression, which must resolve to an array.
fiftyone.core.expressions.ViewExpression.contains

fiftyone.core.expressions.ViewExpression.html#contains

Function

Method

PUBLIC

Checks whether this expression, which must resolve to an array, contains any of the given values.
fiftyone.core.expressions.ViewExpression.is_subset

fiftyone.core.expressions.ViewExpression.html#is_subset

Function

Method

PUBLIC

Checks whether this expression's contents, which must resolve to an array, are a subset of the given array or array expression's contents.
fiftyone.core.expressions.ViewExpression.set_equals

fiftyone.core.expressions.ViewExpression.html#set_equals

Function

Method

PUBLIC

Checks whether this expression, which must resolve to an array, contains the same distinct values as each of the given array(s) or array expression(s).
fiftyone.core.expressions.ViewExpression.unique

fiftyone.core.expressions.ViewExpression.html#unique

Function

Method

PUBLIC

Returns an array containing the unique values in this expression, which must resolve to an array.
fiftyone.core.expressions.ViewExpression.union

fiftyone.core.expressions.ViewExpression.html#union

Function

Method

PUBLIC

Computes the set union of this expression, which must resolve to an array, and the given array(s) or array expression(s).
fiftyone.core.expressions.ViewExpression.intersection

fiftyone.core.expressions.ViewExpression.html#intersection

Function

Method

PUBLIC

Computes the set intersection of this expression, which must resolve to an array, and the given array(s) or array expression(s).
fiftyone.core.expressions.ViewExpression.difference

fiftyone.core.expressions.ViewExpression.html#difference

Function

Method

PUBLIC

Computes the set difference of this expression, which must resolve to an array, and the given array or array expression.
fiftyone.core.expressions.ViewExpression.reverse

fiftyone.core.expressions.ViewExpression.html#reverse

Function

Method

PUBLIC

Reverses the order of the elements in the expression, which must resolve to an array.
fiftyone.core.expressions.ViewExpression.sort

fiftyone.core.expressions.ViewExpression.html#sort

Function

Method

PUBLIC

Sorts this expression, which must resolve to an array.
fiftyone.core.expressions.ViewExpression.filter

fiftyone.core.expressions.ViewExpression.html#filter

Function

Method

PUBLIC

Applies the given filter to the elements of this expression, which must resolve to an array.
fiftyone.core.expressions.ViewExpression.map

fiftyone.core.expressions.ViewExpression.html#map

Function

Method

PUBLIC

Applies the given expression to the elements of this expression, which must resolve to an array.
fiftyone.core.expressions.ViewExpression.reduce

fiftyone.core.expressions.ViewExpression.html#reduce

Function

Method

PUBLIC

Applies the given reduction to this expression, which must resolve to an array, and returns the single value computed.
fiftyone.core.expressions.ViewExpression.prepend

fiftyone.core.expressions.ViewExpression.html#prepend

Function

Method

PUBLIC

Prepends the given value to this expression, which must resolve to an array.
fiftyone.core.expressions.ViewExpression.append

fiftyone.core.expressions.ViewExpression.html#append

Function

Method

PUBLIC

Appends the given value to this expression, which must resolve to an array.
fiftyone.core.expressions.ViewExpression.insert

fiftyone.core.expressions.ViewExpression.html#insert

Function

Method

PUBLIC

Inserts the value before the given index in this expression, which must resolve to an array.
fiftyone.core.expressions.ViewExpression.extend

fiftyone.core.expressions.ViewExpression.html#extend

Function

Method

PUBLIC

Concatenates the given array(s) or array expression(s) to this expression, which must resolve to an array.
fiftyone.core.expressions.ViewExpression.sum

fiftyone.core.expressions.ViewExpression.html#sum

Function

Method

PUBLIC

Returns the sum of the values in this expression, which must resolve to a numeric array.
fiftyone.core.expressions.ViewExpression.mean

fiftyone.core.expressions.ViewExpression.html#mean

Function

Method

PUBLIC

Returns the average value in this expression, which must resolve to a numeric array.
fiftyone.core.expressions.ViewExpression.std

fiftyone.core.expressions.ViewExpression.html#std

Function

Method

PUBLIC

Returns the standard deviation of the values in this expression, which must resolve to a numeric array.
fiftyone.core.expressions.ViewExpression.join

fiftyone.core.expressions.ViewExpression.html#join

Function

Method

PUBLIC

Joins the elements of this expression, which must resolve to a string array, by the given delimiter.
fiftyone.core.expressions.ViewExpression.substr

fiftyone.core.expressions.ViewExpression.html#substr

Function

Method

PUBLIC

Extracts the specified substring from this expression, which must resolve to a string.
fiftyone.core.expressions.ViewExpression.strlen

fiftyone.core.expressions.ViewExpression.html#strlen

Function

Method

PUBLIC

Computes the length of this expression, which must resolve to a string.
fiftyone.core.expressions.ViewExpression.lower

fiftyone.core.expressions.ViewExpression.html#lower

Function

Method

PUBLIC

Converts this expression, which must resolve to a string, to lowercase.
fiftyone.core.expressions.ViewExpression.upper

fiftyone.core.expressions.ViewExpression.html#upper

Function

Method

PUBLIC

Converts this expression, which must resolve to a string, to uppercase.
fiftyone.core.expressions.ViewExpression.concat

fiftyone.core.expressions.ViewExpression.html#concat

Function

Method

PUBLIC

Concatenates the given string(s) to this expression, which must resolve to a string.
fiftyone.core.expressions.ViewExpression.strip

fiftyone.core.expressions.ViewExpression.html#strip

Function

Method

PUBLIC

Removes whitespace characters from the beginning and end of this expression, which must resolve to a string.
fiftyone.core.expressions.ViewExpression.lstrip

fiftyone.core.expressions.ViewExpression.html#lstrip

Function

Method

PUBLIC

Removes whitespace characters from the beginning of this expression, which must resolve to a string.
fiftyone.core.expressions.ViewExpression.rstrip

fiftyone.core.expressions.ViewExpression.html#rstrip

Function

Method

PUBLIC

Removes whitespace characters from the end of this expression, which must resolve to a string.
fiftyone.core.expressions.ViewExpression.replace

fiftyone.core.expressions.ViewExpression.html#replace

Function

Method

PUBLIC

Replaces all occurrences of old with new in this expression, which must resolve to a string.
fiftyone.core.expressions.ViewExpression.re_match

fiftyone.core.expressions.ViewExpression.html#re_match

Function

Method

PUBLIC

Performs a regular expression pattern match on this expression, which must resolve to a string.
fiftyone.core.expressions.ViewExpression.starts_with

fiftyone.core.expressions.ViewExpression.html#starts_with

Function

Method

PUBLIC

Determines whether this expression, which must resolve to a string, starts with the given string or string(s).
fiftyone.core.expressions.ViewExpression.ends_with

fiftyone.core.expressions.ViewExpression.html#ends_with

Function

Method

PUBLIC

Determines whether this expression, which must resolve to a string, ends with the given string or string(s).
fiftyone.core.expressions.ViewExpression.contains_str

fiftyone.core.expressions.ViewExpression.html#contains_str

Function

Method

PUBLIC

Determines whether this expression, which must resolve to a string, contains the given string or string(s).
fiftyone.core.expressions.ViewExpression.matches_str

fiftyone.core.expressions.ViewExpression.html#matches_str

Function

Method

PUBLIC

Determines whether this expression, which must resolve to a string, exactly matches the given string or string(s).
fiftyone.core.expressions.ViewExpression.split

fiftyone.core.expressions.ViewExpression.html#split

Function

Method

PUBLIC

Splits this expression, which must resolve to a string, by the given delimiter.
fiftyone.core.expressions.ViewExpression.rsplit

fiftyone.core.expressions.ViewExpression.html#rsplit

Function

Method

PUBLIC

Splits this expression, which must resolve to a string, by the given delimiter.
fiftyone.core.expressions.ViewExpression.millisecond

fiftyone.core.expressions.ViewExpression.html#millisecond

Function

Method

PUBLIC

Returns the millisecond portion of this date expression (in UTC) as an integer between 0 and 999.
fiftyone.core.expressions.ViewExpression.second

fiftyone.core.expressions.ViewExpression.html#second

Function

Method

PUBLIC

Returns the second portion of this date expression (in UTC) as a number between 0 and 59.
fiftyone.core.expressions.ViewExpression.minute

fiftyone.core.expressions.ViewExpression.html#minute

Function

Method

PUBLIC

Returns the minute portion of this date expression (in UTC) as a number between 0 and 59.
fiftyone.core.expressions.ViewExpression.hour

fiftyone.core.expressions.ViewExpression.html#hour

Function

Method

PUBLIC

Returns the hour portion of this date expression (in UTC) as a number between 0 and 23.
fiftyone.core.expressions.ViewExpression.day_of_week

fiftyone.core.expressions.ViewExpression.html#day_of_week

Function

Method

PUBLIC

Returns the day of the week of this date expression (in UTC) as a number between 1 (Sunday) and 7 (Saturday).
fiftyone.core.expressions.ViewExpression.day_of_month

fiftyone.core.expressions.ViewExpression.html#day_of_month

Function

Method

PUBLIC

Returns the day of the month of this date expression (in UTC) as a number between 1 and 31.
fiftyone.core.expressions.ViewExpression.day_of_year

fiftyone.core.expressions.ViewExpression.html#day_of_year

Function

Method

PUBLIC

Returns the day of the year of this date expression (in UTC) as a number between 1 and 366.
fiftyone.core.expressions.ViewExpression.week

fiftyone.core.expressions.ViewExpression.html#week

Function

Method

PUBLIC

Returns the week of the year of this date expression (in UTC) as a number between 0 and 53.
fiftyone.core.expressions.ViewExpression.month

fiftyone.core.expressions.ViewExpression.html#month

Function

Method

PUBLIC

Returns the month of this date expression (in UTC) as a number between 1 and 12.
fiftyone.core.expressions.ViewExpression.year

fiftyone.core.expressions.ViewExpression.html#year

Function

Method

PUBLIC

Returns the year of this date expression (in UTC).
fiftyone.core.expressions.ViewExpression.literal

fiftyone.core.expressions.ViewExpression.html#literal

Function

Static Method

PUBLIC

Returns an expression representing the given value without parsing.
fiftyone.core.expressions.ViewExpression.rand

fiftyone.core.expressions.ViewExpression.html#rand

Function

Static Method

PUBLIC

Returns an expression that generates a uniform random float in [0, 1] each time it is called.
fiftyone.core.expressions.ViewExpression.randn

fiftyone.core.expressions.ViewExpression.html#randn

Function

Static Method

PUBLIC

Returns an expression that generates a sample from the standard Gaussian distribution each time it is called.
fiftyone.core.expressions.ViewExpression.any

fiftyone.core.expressions.ViewExpression.html#any

Function

Static Method

PUBLIC

Checks whether any of the given expressions evaluate to True.
fiftyone.core.expressions.ViewExpression.all

fiftyone.core.expressions.ViewExpression.html#all

Function

Static Method

PUBLIC

Checks whether all of the given expressions evaluate to True.
fiftyone.core.expressions.ViewExpression.range

fiftyone.core.expressions.ViewExpression.html#range

Function

Static Method

PUBLIC

Returns an array expression containing the sequence of integers from the specified start (inclusive) to stop (exclusive).
fiftyone.core.expressions.ViewExpression.enumerate

fiftyone.core.expressions.ViewExpression.html#enumerate

Function

Static Method

PUBLIC

Returns an array of [index, element] pairs enumerating the elements of the given expression, which must resolve to an array.
fiftyone.core.expressions.ViewExpression.zip

fiftyone.core.expressions.ViewExpression.html#zip

Function

Static Method

PUBLIC

Zips the given expressions, which must resolve to arrays, into an array whose ith element is an array containing the ith element from each input array.
fiftyone.core.expressions.ViewExpression._function

fiftyone.core.expressions.ViewExpression.html#_function

Function

Method

PRIVATE

Undocumented
fiftyone.core.expressions.ViewField

fiftyone.core.expressions.ViewField.html

Class

Class

PUBLIC

A ViewExpression that refers to a field or embedded field of a document.
fiftyone.core.expressions.ViewField.__init__

fiftyone.core.expressions.ViewField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.expressions.ViewField.__deepcopy__

fiftyone.core.expressions.ViewField.html#__deepcopy__

Function

Method

PUBLIC

Undocumented
fiftyone.core.expressions.ViewField.to_mongo

fiftyone.core.expressions.ViewField.html#to_mongo

Function

Method

PUBLIC

Returns a MongoDB representation of the field.
fiftyone.core.expressions.ObjectId

fiftyone.core.expressions.ObjectId.html

Class

Class

PUBLIC

A ViewExpression that refers to an ObjectId of a document.
fiftyone.core.expressions.ObjectId.__init__

fiftyone.core.expressions.ObjectId.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.expressions.ObjectId.to_mongo

fiftyone.core.expressions.ObjectId.html#to_mongo

Function

Method

PUBLIC

Returns a MongoDB representation of the ObjectId.
fiftyone.core.expressions._do_to_mongo

fiftyone.core.expressions.html#_do_to_mongo

Function

Function

PRIVATE

Undocumented
fiftyone.core.expressions._do_freeze_prefix

fiftyone.core.expressions.html#_do_freeze_prefix

Function

Function

PRIVATE

Undocumented
fiftyone.core.expressions._do_apply_memo

fiftyone.core.expressions.html#_do_apply_memo

Function

Function

PRIVATE

Undocumented
fiftyone.core.expressions._do_recurse

fiftyone.core.expressions.html#_do_recurse

Function

Function

PRIVATE

Undocumented
fiftyone.core.expressions.VALUE

fiftyone.core.expressions.html#VALUE

Attribute

Constant

PUBLIC

A ViewExpression that refers to the current $$value in a MongoDB reduction expression.
fiftyone.core.expressions._escape_regex_chars

fiftyone.core.expressions.html#_escape_regex_chars

Function

Function

PRIVATE

Undocumented
fiftyone.core.aggregations.logger

fiftyone.core.aggregations.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.aggregations.Aggregation

fiftyone.core.aggregations.Aggregation.html

Class

Class

PUBLIC

Abstract base class for all aggregations.
fiftyone.core.aggregations.Aggregation._uuid

fiftyone.core.aggregations.Aggregation.html#_uuid

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Aggregation.__init__

fiftyone.core.aggregations.Aggregation.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.aggregations.Aggregation._field_name

fiftyone.core.aggregations.Aggregation.html#_field_name

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Aggregation._expr

fiftyone.core.aggregations.Aggregation.html#_expr

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Aggregation._safe

fiftyone.core.aggregations.Aggregation.html#_safe

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Aggregation.__str__

fiftyone.core.aggregations.Aggregation.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.aggregations.Aggregation.__repr__

fiftyone.core.aggregations.Aggregation.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.aggregations.Aggregation.__eq__

fiftyone.core.aggregations.Aggregation.html#__eq__

Function

Method

PUBLIC

Undocumented
fiftyone.core.aggregations.Aggregation.field_name

fiftyone.core.aggregations.Aggregation.html#field_name

Attribute

Property

PUBLIC

The name of the field being computed on, if any.
fiftyone.core.aggregations.Aggregation.expr

fiftyone.core.aggregations.Aggregation.html#expr

Attribute

Property

PUBLIC

The expression being computed, if any.
fiftyone.core.aggregations.Aggregation.safe

fiftyone.core.aggregations.Aggregation.html#safe

Attribute

Property

PUBLIC

Whether nan/inf values will be ignored when dealing with floating point values.
fiftyone.core.aggregations.Aggregation._has_big_result

fiftyone.core.aggregations.Aggregation.html#_has_big_result

Attribute

Property

PRIVATE

Whether the aggregation's result is returned across multiple documents.
fiftyone.core.aggregations.Aggregation._is_big_batchable

fiftyone.core.aggregations.Aggregation.html#_is_big_batchable

Attribute

Property

PRIVATE

Whether the aggregation has big results and its pipeline is defined by a single $project stage and thus can be combined with other such aggregations.
fiftyone.core.aggregations.Aggregation.to_mongo

fiftyone.core.aggregations.Aggregation.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for this aggregation.
fiftyone.core.aggregations.Aggregation.parse_result

fiftyone.core.aggregations.Aggregation.html#parse_result

Function

Method

PUBLIC

Parses the output of to_mongo.
fiftyone.core.aggregations.Aggregation.default_result

fiftyone.core.aggregations.Aggregation.html#default_result

Function

Method

PUBLIC

Returns the default result for this aggregation.
fiftyone.core.aggregations.Aggregation._needs_frames

fiftyone.core.aggregations.Aggregation.html#_needs_frames

Function

Method

PRIVATE

Whether the aggregation requires frame labels of video samples to be attached.
fiftyone.core.aggregations.Aggregation._needs_group_slices

fiftyone.core.aggregations.Aggregation.html#_needs_group_slices

Function

Method

PRIVATE

Whether the aggregation requires group slice(s) to be attached.
fiftyone.core.aggregations.Aggregation._serialize

fiftyone.core.aggregations.Aggregation.html#_serialize

Function

Method

PRIVATE

Returns a JSON dict representation of the Aggregation.
fiftyone.core.aggregations.Aggregation._kwargs

fiftyone.core.aggregations.Aggregation.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this aggregation instance.
fiftyone.core.aggregations.Aggregation._from_dict

fiftyone.core.aggregations.Aggregation.html#_from_dict

Function

Class Method

PRIVATE

Creates an Aggregation instance from a serialized JSON dict representation of it.
fiftyone.core.aggregations.AggregationError

fiftyone.core.aggregations.AggregationError.html

Class

Exception

PUBLIC

An error raised during the execution of an Aggregation.
fiftyone.core.aggregations.Bounds

fiftyone.core.aggregations.Bounds.html

Class

Class

PUBLIC

Computes the bounds of a numeric field of a collection.
fiftyone.core.aggregations.Bounds.__init__

fiftyone.core.aggregations.Bounds.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.aggregations.Bounds._count_nonfinites

fiftyone.core.aggregations.Bounds.html#_count_nonfinites

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Bounds._kwargs

fiftyone.core.aggregations.Bounds.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this aggregation instance.
fiftyone.core.aggregations.Bounds.default_result

fiftyone.core.aggregations.Bounds.html#default_result

Function

Method

PUBLIC

Returns the default result for this aggregation.
fiftyone.core.aggregations.Bounds.parse_result

fiftyone.core.aggregations.Bounds.html#parse_result

Function

Method

PUBLIC

Parses the output of to_mongo.
fiftyone.core.aggregations.Bounds.to_mongo

fiftyone.core.aggregations.Bounds.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for this aggregation.
fiftyone.core.aggregations.Bounds._field_type

fiftyone.core.aggregations.Bounds.html#_field_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Count

fiftyone.core.aggregations.Count.html

Class

Class

PUBLIC

Counts the number of field values in a collection.
fiftyone.core.aggregations.Count.__init__

fiftyone.core.aggregations.Count.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.aggregations.Count._unwind

fiftyone.core.aggregations.Count.html#_unwind

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Count._kwargs

fiftyone.core.aggregations.Count.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this aggregation instance.
fiftyone.core.aggregations.Count.default_result

fiftyone.core.aggregations.Count.html#default_result

Function

Method

PUBLIC

Returns the default result for this aggregation.
fiftyone.core.aggregations.Count.parse_result

fiftyone.core.aggregations.Count.html#parse_result

Function

Method

PUBLIC

Parses the output of to_mongo.
fiftyone.core.aggregations.Count.to_mongo

fiftyone.core.aggregations.Count.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for this aggregation.
fiftyone.core.aggregations.CountValues

fiftyone.core.aggregations.CountValues.html

Class

Class

PUBLIC

Counts the occurrences of field values in a collection.
fiftyone.core.aggregations.CountValues.__init__

fiftyone.core.aggregations.CountValues.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.aggregations.CountValues._first

fiftyone.core.aggregations.CountValues.html#_first

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.CountValues._sort_by

fiftyone.core.aggregations.CountValues.html#_sort_by

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.CountValues._asc

fiftyone.core.aggregations.CountValues.html#_asc

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.CountValues._include

fiftyone.core.aggregations.CountValues.html#_include

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.CountValues._search

fiftyone.core.aggregations.CountValues.html#_search

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.CountValues._selected

fiftyone.core.aggregations.CountValues.html#_selected

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.CountValues._field_type

fiftyone.core.aggregations.CountValues.html#_field_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.CountValues._kwargs

fiftyone.core.aggregations.CountValues.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this aggregation instance.
fiftyone.core.aggregations.CountValues.default_result

fiftyone.core.aggregations.CountValues.html#default_result

Function

Method

PUBLIC

Returns the default result for this aggregation.
fiftyone.core.aggregations.CountValues.parse_result

fiftyone.core.aggregations.CountValues.html#parse_result

Function

Method

PUBLIC

Parses the output of to_mongo.
fiftyone.core.aggregations.CountValues.to_mongo

fiftyone.core.aggregations.CountValues.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for this aggregation.
fiftyone.core.aggregations.Distinct

fiftyone.core.aggregations.Distinct.html

Class

Class

PUBLIC

Computes the distinct values of a field in a collection.
fiftyone.core.aggregations.Distinct.__init__

fiftyone.core.aggregations.Distinct.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.aggregations.Distinct._field_type

fiftyone.core.aggregations.Distinct.html#_field_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Distinct.default_result

fiftyone.core.aggregations.Distinct.html#default_result

Function

Method

PUBLIC

Returns the default result for this aggregation.
fiftyone.core.aggregations.Distinct.parse_result

fiftyone.core.aggregations.Distinct.html#parse_result

Function

Method

PUBLIC

Parses the output of to_mongo.
fiftyone.core.aggregations.Distinct.to_mongo

fiftyone.core.aggregations.Distinct.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for this aggregation.
fiftyone.core.aggregations.FacetAggregations

fiftyone.core.aggregations.FacetAggregations.html

Class

Class

PUBLIC

Efficiently computes a set of aggregations rooted at a common path using faceted computations.
fiftyone.core.aggregations.FacetAggregations.__init__

fiftyone.core.aggregations.FacetAggregations.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.aggregations.FacetAggregations._raw_aggregations

fiftyone.core.aggregations.FacetAggregations.html#_raw_aggregations

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.FacetAggregations._aggregations

fiftyone.core.aggregations.FacetAggregations.html#_aggregations

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.FacetAggregations._compiled

fiftyone.core.aggregations.FacetAggregations.html#_compiled

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.FacetAggregations._is_dict

fiftyone.core.aggregations.FacetAggregations.html#_is_dict

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.FacetAggregations._serialize

fiftyone.core.aggregations.FacetAggregations.html#_serialize

Function

Method

PRIVATE

Returns a JSON dict representation of the Aggregation.
fiftyone.core.aggregations.FacetAggregations._uuid

fiftyone.core.aggregations.FacetAggregations.html#_uuid

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.FacetAggregations._kwargs

fiftyone.core.aggregations.FacetAggregations.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this aggregation instance.
fiftyone.core.aggregations.FacetAggregations.default_result

fiftyone.core.aggregations.FacetAggregations.html#default_result

Function

Method

PUBLIC

Returns the default result for this aggregation.
fiftyone.core.aggregations.FacetAggregations.parse_result

fiftyone.core.aggregations.FacetAggregations.html#parse_result

Function

Method

PUBLIC

Parses the output of to_mongo.
fiftyone.core.aggregations.FacetAggregations.to_mongo

fiftyone.core.aggregations.FacetAggregations.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for this aggregation.
fiftyone.core.aggregations.FacetAggregations._path

fiftyone.core.aggregations.FacetAggregations.html#_path

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.FacetAggregations._get_key

fiftyone.core.aggregations.FacetAggregations.html#_get_key

Function

Static Method

PRIVATE

Undocumented
fiftyone.core.aggregations.FacetAggregations._parse_aggregations

fiftyone.core.aggregations.FacetAggregations.html#_parse_aggregations

Function

Static Method

PRIVATE

Undocumented
fiftyone.core.aggregations.FacetAggregations._serialize_aggregations

fiftyone.core.aggregations.FacetAggregations.html#_serialize_aggregations

Function

Static Method

PRIVATE

Undocumented
fiftyone.core.aggregations._serialize_aggregation

fiftyone.core.aggregations.html#_serialize_aggregation

Function

Function

PRIVATE

Undocumented
fiftyone.core.aggregations.HistogramValues

fiftyone.core.aggregations.HistogramValues.html

Class

Class

PUBLIC

Computes a histogram of the field values in a collection.
fiftyone.core.aggregations.HistogramValues.__init__

fiftyone.core.aggregations.HistogramValues.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.aggregations.HistogramValues._bins

fiftyone.core.aggregations.HistogramValues.html#_bins

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.HistogramValues._range

fiftyone.core.aggregations.HistogramValues.html#_range

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.HistogramValues._auto

fiftyone.core.aggregations.HistogramValues.html#_auto

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.HistogramValues._field_type

fiftyone.core.aggregations.HistogramValues.html#_field_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.HistogramValues._is_datetime

fiftyone.core.aggregations.HistogramValues.html#_is_datetime

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.HistogramValues._num_bins

fiftyone.core.aggregations.HistogramValues.html#_num_bins

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.HistogramValues._edges

fiftyone.core.aggregations.HistogramValues.html#_edges

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.HistogramValues._last_edges

fiftyone.core.aggregations.HistogramValues.html#_last_edges

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.HistogramValues._kwargs

fiftyone.core.aggregations.HistogramValues.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this aggregation instance.
fiftyone.core.aggregations.HistogramValues.default_result

fiftyone.core.aggregations.HistogramValues.html#default_result

Function

Method

PUBLIC

Returns the default result for this aggregation.
fiftyone.core.aggregations.HistogramValues.parse_result

fiftyone.core.aggregations.HistogramValues.html#parse_result

Function

Method

PUBLIC

Parses the output of to_mongo.
fiftyone.core.aggregations.HistogramValues.to_mongo

fiftyone.core.aggregations.HistogramValues.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for this aggregation.
fiftyone.core.aggregations.HistogramValues._parse_args

fiftyone.core.aggregations.HistogramValues.html#_parse_args

Function

Method

PRIVATE

Undocumented
fiftyone.core.aggregations.HistogramValues._compute_bin_edges

fiftyone.core.aggregations.HistogramValues.html#_compute_bin_edges

Function

Method

PRIVATE

Undocumented
fiftyone.core.aggregations.HistogramValues._parse_result_edges

fiftyone.core.aggregations.HistogramValues.html#_parse_result_edges

Function

Method

PRIVATE

Undocumented
fiftyone.core.aggregations.HistogramValues._parse_result_auto

fiftyone.core.aggregations.HistogramValues.html#_parse_result_auto

Function

Method

PRIVATE

Undocumented
fiftyone.core.aggregations.HistogramValues._parse_edges

fiftyone.core.aggregations.HistogramValues.html#_parse_edges

Function

Method

PRIVATE

Undocumented
fiftyone.core.aggregations.Min

fiftyone.core.aggregations.Min.html

Class

Class

PUBLIC

Computes the minimum of a numeric field of a collection.
fiftyone.core.aggregations.Min.default_result

fiftyone.core.aggregations.Min.html#default_result

Function

Method

PUBLIC

Returns the default result for this aggregation.
fiftyone.core.aggregations.Min.parse_result

fiftyone.core.aggregations.Min.html#parse_result

Function

Method

PUBLIC

Parses the output of to_mongo.
fiftyone.core.aggregations.Min.to_mongo

fiftyone.core.aggregations.Min.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for this aggregation.
fiftyone.core.aggregations.Min._field_type

fiftyone.core.aggregations.Min.html#_field_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Max

fiftyone.core.aggregations.Max.html

Class

Class

PUBLIC

Computes the maximum of a numeric field of a collection.
fiftyone.core.aggregations.Max.default_result

fiftyone.core.aggregations.Max.html#default_result

Function

Method

PUBLIC

Returns the default result for this aggregation.
fiftyone.core.aggregations.Max.parse_result

fiftyone.core.aggregations.Max.html#parse_result

Function

Method

PUBLIC

Parses the output of to_mongo.
fiftyone.core.aggregations.Max.to_mongo

fiftyone.core.aggregations.Max.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for this aggregation.
fiftyone.core.aggregations.Max._field_type

fiftyone.core.aggregations.Max.html#_field_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Mean

fiftyone.core.aggregations.Mean.html

Class

Class

PUBLIC

Computes the arithmetic mean of the field values of a collection.
fiftyone.core.aggregations.Mean.default_result

fiftyone.core.aggregations.Mean.html#default_result

Function

Method

PUBLIC

Returns the default result for this aggregation.
fiftyone.core.aggregations.Mean.parse_result

fiftyone.core.aggregations.Mean.html#parse_result

Function

Method

PUBLIC

Parses the output of to_mongo.
fiftyone.core.aggregations.Mean.to_mongo

fiftyone.core.aggregations.Mean.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for this aggregation.
fiftyone.core.aggregations.Quantiles

fiftyone.core.aggregations.Quantiles.html

Class

Class

PUBLIC

Computes the quantile(s) of the field values of a collection.
fiftyone.core.aggregations.Quantiles.__init__

fiftyone.core.aggregations.Quantiles.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.aggregations.Quantiles._quantiles

fiftyone.core.aggregations.Quantiles.html#_quantiles

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Quantiles._quantiles_list

fiftyone.core.aggregations.Quantiles.html#_quantiles_list

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Quantiles._is_scalar

fiftyone.core.aggregations.Quantiles.html#_is_scalar

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Quantiles._kwargs

fiftyone.core.aggregations.Quantiles.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this aggregation instance.
fiftyone.core.aggregations.Quantiles.default_result

fiftyone.core.aggregations.Quantiles.html#default_result

Function

Method

PUBLIC

Returns the default result for this aggregation.
fiftyone.core.aggregations.Quantiles.parse_result

fiftyone.core.aggregations.Quantiles.html#parse_result

Function

Method

PUBLIC

Parses the output of to_mongo.
fiftyone.core.aggregations.Quantiles.to_mongo

fiftyone.core.aggregations.Quantiles.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for this aggregation.
fiftyone.core.aggregations.Quantiles._parse_quantiles

fiftyone.core.aggregations.Quantiles.html#_parse_quantiles

Function

Static Method

PRIVATE

Undocumented
fiftyone.core.aggregations.Schema

fiftyone.core.aggregations.Schema.html

Class

Class

PUBLIC

Extracts the names and types of the attributes of a specified embedded document field across all samples in a collection.
fiftyone.core.aggregations.Schema.__init__

fiftyone.core.aggregations.Schema.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.aggregations.Schema._dynamic_only

fiftyone.core.aggregations.Schema.html#_dynamic_only

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Schema._include_private

fiftyone.core.aggregations.Schema.html#_include_private

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Schema._doc_type

fiftyone.core.aggregations.Schema.html#_doc_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Schema._kwargs

fiftyone.core.aggregations.Schema.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this aggregation instance.
fiftyone.core.aggregations.Schema.default_result

fiftyone.core.aggregations.Schema.html#default_result

Function

Method

PUBLIC

Returns the default result for this aggregation.
fiftyone.core.aggregations.Schema.parse_result

fiftyone.core.aggregations.Schema.html#parse_result

Function

Method

PUBLIC

Parses the output of to_mongo.
fiftyone.core.aggregations.Schema.to_mongo

fiftyone.core.aggregations.Schema.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for this aggregation.
fiftyone.core.aggregations.ListSchema

fiftyone.core.aggregations.ListSchema.html

Class

Class

PUBLIC

Extracts the value type(s) in a specified list field across all samples in a collection.
fiftyone.core.aggregations.ListSchema.__init__

fiftyone.core.aggregations.ListSchema.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.aggregations.ListSchema._kwargs

fiftyone.core.aggregations.ListSchema.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this aggregation instance.
fiftyone.core.aggregations.ListSchema.default_result

fiftyone.core.aggregations.ListSchema.html#default_result

Function

Method

PUBLIC

Returns the default result for this aggregation.
fiftyone.core.aggregations.ListSchema.parse_result

fiftyone.core.aggregations.ListSchema.html#parse_result

Function

Method

PUBLIC

Parses the output of to_mongo.
fiftyone.core.aggregations.ListSchema.to_mongo

fiftyone.core.aggregations.ListSchema.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for this aggregation.
fiftyone.core.aggregations._resolve_types

fiftyone.core.aggregations.html#_resolve_types

Function

Function

PRIVATE

Undocumented
fiftyone.core.aggregations.Std

fiftyone.core.aggregations.Std.html

Class

Class

PUBLIC

Computes the standard deviation of the field values of a collection.
fiftyone.core.aggregations.Std.__init__

fiftyone.core.aggregations.Std.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.aggregations.Std._sample

fiftyone.core.aggregations.Std.html#_sample

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Std._kwargs

fiftyone.core.aggregations.Std.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this aggregation instance.
fiftyone.core.aggregations.Std.default_result

fiftyone.core.aggregations.Std.html#default_result

Function

Method

PUBLIC

Returns the default result for this aggregation.
fiftyone.core.aggregations.Std.parse_result

fiftyone.core.aggregations.Std.html#parse_result

Function

Method

PUBLIC

Parses the output of to_mongo.
fiftyone.core.aggregations.Std.to_mongo

fiftyone.core.aggregations.Std.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for this aggregation.
fiftyone.core.aggregations.Sum

fiftyone.core.aggregations.Sum.html

Class

Class

PUBLIC

Computes the sum of the field values of a collection.
fiftyone.core.aggregations.Sum.default_result

fiftyone.core.aggregations.Sum.html#default_result

Function

Method

PUBLIC

Returns the default result for this aggregation.
fiftyone.core.aggregations.Sum.parse_result

fiftyone.core.aggregations.Sum.html#parse_result

Function

Method

PUBLIC

Parses the output of to_mongo.
fiftyone.core.aggregations.Sum.to_mongo

fiftyone.core.aggregations.Sum.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for this aggregation.
fiftyone.core.aggregations.Values

fiftyone.core.aggregations.Values.html

Class

Class

PUBLIC

Extracts the values of the field from all samples in a collection.
fiftyone.core.aggregations.Values.__init__

fiftyone.core.aggregations.Values.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.aggregations.Values._missing_value

fiftyone.core.aggregations.Values.html#_missing_value

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Values._unwind

fiftyone.core.aggregations.Values.html#_unwind

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Values._allow_missing

fiftyone.core.aggregations.Values.html#_allow_missing

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Values._big_result

fiftyone.core.aggregations.Values.html#_big_result

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Values._raw

fiftyone.core.aggregations.Values.html#_raw

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Values._field

fiftyone.core.aggregations.Values.html#_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Values._big_field

fiftyone.core.aggregations.Values.html#_big_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Values._manual_field

fiftyone.core.aggregations.Values.html#_manual_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Values._num_list_fields

fiftyone.core.aggregations.Values.html#_num_list_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.aggregations.Values._kwargs

fiftyone.core.aggregations.Values.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this aggregation instance.
fiftyone.core.aggregations.Values._has_big_result

fiftyone.core.aggregations.Values.html#_has_big_result

Attribute

Property

PRIVATE

Whether the aggregation's result is returned across multiple documents.
fiftyone.core.aggregations.Values._is_big_batchable

fiftyone.core.aggregations.Values.html#_is_big_batchable

Attribute

Property

PRIVATE

Whether the aggregation has big results and its pipeline is defined by a single $project stage and thus can be combined with other such aggregations.
fiftyone.core.aggregations.Values.default_result

fiftyone.core.aggregations.Values.html#default_result

Function

Method

PUBLIC

Returns the default result for this aggregation.
fiftyone.core.aggregations.Values.parse_result

fiftyone.core.aggregations.Values.html#parse_result

Function

Method

PUBLIC

Parses the output of to_mongo.
fiftyone.core.aggregations.Values.to_mongo

fiftyone.core.aggregations.Values.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for this aggregation.
fiftyone.core.aggregations._AggregationRepr

fiftyone.core.aggregations._AggregationRepr.html

Class

Class

PRIVATE

Undocumented
fiftyone.core.aggregations._AggregationRepr.repr_ViewExpression

fiftyone.core.aggregations._AggregationRepr.html#repr_ViewExpression

Function

Method

PUBLIC

Undocumented
fiftyone.core.aggregations._repr

fiftyone.core.aggregations.html#_repr

Attribute

Variable

PRIVATE

Undocumented
fiftyone.core.aggregations._MONGO_TO_FIFTYONE_TYPES

fiftyone.core.aggregations.html#_MONGO_TO_FIFTYONE_TYPES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.aggregations._transform_values

fiftyone.core.aggregations.html#_transform_values

Function

Function

PRIVATE

Undocumented
fiftyone.core.aggregations._make_extract_values_pipeline

fiftyone.core.aggregations.html#_make_extract_values_pipeline

Function

Function

PRIVATE

Undocumented
fiftyone.core.aggregations._extract_list_values

fiftyone.core.aggregations.html#_extract_list_values

Function

Function

PRIVATE

Undocumented
fiftyone.core.aggregations._parse_field_and_expr

fiftyone.core.aggregations.html#_parse_field_and_expr

Function

Function

PRIVATE

Undocumented
fiftyone.core.aggregations._to_safe_expr

fiftyone.core.aggregations.html#_to_safe_expr

Function

Function

PRIVATE

Undocumented
fiftyone.core.aggregations._handle_reduce_unwinds

fiftyone.core.aggregations.html#_handle_reduce_unwinds

Function

Function

PRIVATE

Undocumented
fiftyone.core.aggregations._replace_list

fiftyone.core.aggregations.html#_replace_list

Function

Function

PRIVATE

Undocumented
fiftyone.core.aggregations._extract_prefix_from_expr

fiftyone.core.aggregations.html#_extract_prefix_from_expr

Function

Function

PRIVATE

Undocumented
fiftyone.core.aggregations._find_prefixes

fiftyone.core.aggregations.html#_find_prefixes

Function

Function

PRIVATE

Undocumented
fiftyone.core.aggregations._get_common_prefix

fiftyone.core.aggregations.html#_get_common_prefix

Function

Function

PRIVATE

Undocumented
fiftyone.core.aggregations._remove_prefix

fiftyone.core.aggregations.html#_remove_prefix

Function

Function

PRIVATE

Undocumented
fiftyone.core.aggregations._get_field_type

fiftyone.core.aggregations.html#_get_field_type

Function

Function

PRIVATE

Undocumented
fiftyone.core.aggregations._handle_dates

fiftyone.core.aggregations.html#_handle_dates

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections.fod

fiftyone.core.collections.html#fod

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.collections.fos

fiftyone.core.collections.html#fos

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.collections.fov

fiftyone.core.collections.html#fov

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.collections.foua

fiftyone.core.collections.html#foua

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.collections.foud

fiftyone.core.collections.html#foud

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.collections.foue

fiftyone.core.collections.html#foue

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.collections.foos

fiftyone.core.collections.html#foos

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.collections.logger

fiftyone.core.collections.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.collections._make_registrar

fiftyone.core.collections.html#_make_registrar

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections.view_stage

fiftyone.core.collections.html#view_stage

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.collections.aggregation

fiftyone.core.collections.html#aggregation

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.collections.SaveContext

fiftyone.core.collections.SaveContext.html

Class

Class

PUBLIC

Context that saves samples from a collection according to a configurable batching strategy.
fiftyone.core.collections.SaveContext.batch_size

fiftyone.core.collections.SaveContext.html#batch_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.collections.SaveContext.__init__

fiftyone.core.collections.SaveContext.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.collections.SaveContext.sample_collection

fiftyone.core.collections.SaveContext.html#sample_collection

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.collections.SaveContext._dataset

fiftyone.core.collections.SaveContext.html#_dataset

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.collections.SaveContext._sample_coll

fiftyone.core.collections.SaveContext.html#_sample_coll

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.collections.SaveContext._frame_coll

fiftyone.core.collections.SaveContext.html#_frame_coll

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.collections.SaveContext._is_generated

fiftyone.core.collections.SaveContext.html#_is_generated

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.collections.SaveContext._sample_ops

fiftyone.core.collections.SaveContext.html#_sample_ops

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.collections.SaveContext._frame_ops

fiftyone.core.collections.SaveContext.html#_frame_ops

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.collections.SaveContext._batch_ids

fiftyone.core.collections.SaveContext.html#_batch_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.collections.SaveContext._reload_parents

fiftyone.core.collections.SaveContext.html#_reload_parents

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.collections.SaveContext._batching_strategy

fiftyone.core.collections.SaveContext.html#_batching_strategy

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.collections.SaveContext._curr_batch_size

fiftyone.core.collections.SaveContext.html#_curr_batch_size

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.collections.SaveContext._curr_batch_size_bytes

fiftyone.core.collections.SaveContext.html#_curr_batch_size_bytes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.collections.SaveContext._last_time

fiftyone.core.collections.SaveContext.html#_last_time

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.collections.SaveContext.__enter__

fiftyone.core.collections.SaveContext.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.core.collections.SaveContext.__exit__

fiftyone.core.collections.SaveContext.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.core.collections.SaveContext.save

fiftyone.core.collections.SaveContext.html#save

Function

Method

PUBLIC

Registers the sample for saving in the next batch.
fiftyone.core.collections.SaveContext._save_batch

fiftyone.core.collections.SaveContext.html#_save_batch

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection

fiftyone.core.collections.SampleCollection.html

Class

Class

PUBLIC

Abstract class representing an ordered collection of fiftyone.core.sample.Sample instances in a fiftyone.core.dataset.Dataset.
fiftyone.core.collections.SampleCollection.__slots__

fiftyone.core.collections.SampleCollection.html#__slots__

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.collections.SampleCollection._FRAMES_PREFIX

fiftyone.core.collections.SampleCollection.html#_FRAMES_PREFIX

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._GROUPS_PREFIX

fiftyone.core.collections.SampleCollection.html#_GROUPS_PREFIX

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection.__str__

fiftyone.core.collections.SampleCollection.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.collections.SampleCollection.__repr__

fiftyone.core.collections.SampleCollection.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.collections.SampleCollection.__bool__

fiftyone.core.collections.SampleCollection.html#__bool__

Function

Method

PUBLIC

Undocumented
fiftyone.core.collections.SampleCollection.__len__

fiftyone.core.collections.SampleCollection.html#__len__

Function

Method

PUBLIC

Undocumented
fiftyone.core.collections.SampleCollection.__contains__

fiftyone.core.collections.SampleCollection.html#__contains__

Function

Method

PUBLIC

Undocumented
fiftyone.core.collections.SampleCollection.__getitem__

fiftyone.core.collections.SampleCollection.html#__getitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.collections.SampleCollection.__iter__

fiftyone.core.collections.SampleCollection.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.core.collections.SampleCollection.__add__

fiftyone.core.collections.SampleCollection.html#__add__

Function

Method

PUBLIC

Undocumented
fiftyone.core.collections.SampleCollection._dataset

fiftyone.core.collections.SampleCollection.html#_dataset

Attribute

Property

PRIVATE

The fiftyone.core.dataset.Dataset that serves the samples in this collection.
fiftyone.core.collections.SampleCollection._root_dataset

fiftyone.core.collections.SampleCollection.html#_root_dataset

Attribute

Property

PRIVATE

The root fiftyone.core.dataset.Dataset from which this collection is derived.
fiftyone.core.collections.SampleCollection._is_generated

fiftyone.core.collections.SampleCollection.html#_is_generated

Attribute

Property

PRIVATE

Whether this collection's contents is generated from another collection.
fiftyone.core.collections.SampleCollection._is_patches

fiftyone.core.collections.SampleCollection.html#_is_patches

Attribute

Property

PRIVATE

Whether this collection contains patches.
fiftyone.core.collections.SampleCollection._is_frames

fiftyone.core.collections.SampleCollection.html#_is_frames

Attribute

Property

PRIVATE

Whether this collection contains frames of a video dataset.
fiftyone.core.collections.SampleCollection._is_clips

fiftyone.core.collections.SampleCollection.html#_is_clips

Attribute

Property

PRIVATE

Whether this collection contains clips.
fiftyone.core.collections.SampleCollection._is_dynamic_groups

fiftyone.core.collections.SampleCollection.html#_is_dynamic_groups

Attribute

Property

PRIVATE

Whether this collection contains dynamic groups.
fiftyone.core.collections.SampleCollection._element_str

fiftyone.core.collections.SampleCollection.html#_element_str

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._elements_str

fiftyone.core.collections.SampleCollection.html#_elements_str

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection.name

fiftyone.core.collections.SampleCollection.html#name

Attribute

Property

PUBLIC

The name of the collection.
fiftyone.core.collections.SampleCollection.media_type

fiftyone.core.collections.SampleCollection.html#media_type

Attribute

Property

PUBLIC

The media type of the collection.
fiftyone.core.collections.SampleCollection.group_field

fiftyone.core.collections.SampleCollection.html#group_field

Attribute

Property

PUBLIC

The group field of the collection, or None if the collection is not grouped.
fiftyone.core.collections.SampleCollection.group_slice

fiftyone.core.collections.SampleCollection.html#group_slice

Attribute

Property

PUBLIC

The current group slice of the collection, or None if the collection is not grouped.
fiftyone.core.collections.SampleCollection.group_slices

fiftyone.core.collections.SampleCollection.html#group_slices

Attribute

Property

PUBLIC

The list of group slices of the collection, or None if the collection is not grouped.
fiftyone.core.collections.SampleCollection.group_media_types

fiftyone.core.collections.SampleCollection.html#group_media_types

Attribute

Property

PUBLIC

A dict mapping group slices to media types, or None if the collection is not grouped.
fiftyone.core.collections.SampleCollection.default_group_slice

fiftyone.core.collections.SampleCollection.html#default_group_slice

Attribute

Property

PUBLIC

The default group slice of the collection, or None if the collection is not grouped.
fiftyone.core.collections.SampleCollection.tags

fiftyone.core.collections.SampleCollection.html#tags

Attribute

Property

PUBLIC

The list of tags of the underlying dataset.
fiftyone.core.collections.SampleCollection.tags.setter

fiftyone.core.collections.SampleCollection.html#tags.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.collections.SampleCollection.description

fiftyone.core.collections.SampleCollection.html#description

Attribute

Property

PUBLIC

A description of the underlying dataset.
fiftyone.core.collections.SampleCollection.description.setter

fiftyone.core.collections.SampleCollection.html#description.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.collections.SampleCollection.info

fiftyone.core.collections.SampleCollection.html#info

Attribute

Property

PUBLIC

The info dict of the underlying dataset.
fiftyone.core.collections.SampleCollection.app_config

fiftyone.core.collections.SampleCollection.html#app_config

Attribute

Property

PUBLIC

Dataset-specific settings that customize how this collection is visualized in the :ref:`FiftyOne App <fiftyone-app>`.
fiftyone.core.collections.SampleCollection.classes

fiftyone.core.collections.SampleCollection.html#classes

Attribute

Property

PUBLIC

The classes of the underlying dataset.
fiftyone.core.collections.SampleCollection.default_classes

fiftyone.core.collections.SampleCollection.html#default_classes

Attribute

Property

PUBLIC

The default classes of the underlying dataset.
fiftyone.core.collections.SampleCollection.has_classes

fiftyone.core.collections.SampleCollection.html#has_classes

Function

Method

PUBLIC

Determines whether this collection has a classes list for the given field.
fiftyone.core.collections.SampleCollection.get_classes

fiftyone.core.collections.SampleCollection.html#get_classes

Function

Method

PUBLIC

Gets the classes list for the given field, or None if no classes are available.
fiftyone.core.collections.SampleCollection.mask_targets

fiftyone.core.collections.SampleCollection.html#mask_targets

Attribute

Property

PUBLIC

The mask targets of the underlying dataset.
fiftyone.core.collections.SampleCollection.default_mask_targets

fiftyone.core.collections.SampleCollection.html#default_mask_targets

Attribute

Property

PUBLIC

The default mask targets of the underlying dataset.
fiftyone.core.collections.SampleCollection.has_mask_targets

fiftyone.core.collections.SampleCollection.html#has_mask_targets

Function

Method

PUBLIC

Determines whether this collection has mask targets for the given field.
fiftyone.core.collections.SampleCollection.get_mask_targets

fiftyone.core.collections.SampleCollection.html#get_mask_targets

Function

Method

PUBLIC

Gets the mask targets for the given field, or None if no mask targets are available.
fiftyone.core.collections.SampleCollection.skeletons

fiftyone.core.collections.SampleCollection.html#skeletons

Attribute

Property

PUBLIC

The keypoint skeletons of the underlying dataset.
fiftyone.core.collections.SampleCollection.default_skeleton

fiftyone.core.collections.SampleCollection.html#default_skeleton

Attribute

Property

PUBLIC

The default keypoint skeleton of the underlying dataset.
fiftyone.core.collections.SampleCollection.has_skeleton

fiftyone.core.collections.SampleCollection.html#has_skeleton

Function

Method

PUBLIC

Determines whether this collection has a keypoint skeleton for the given field.
fiftyone.core.collections.SampleCollection.get_skeleton

fiftyone.core.collections.SampleCollection.html#get_skeleton

Function

Method

PUBLIC

Gets the keypoint skeleton for the given field, or None if no skeleton is available.
fiftyone.core.collections.SampleCollection.summary

fiftyone.core.collections.SampleCollection.html#summary

Function

Method

PUBLIC

Returns a string summary of the collection.
fiftyone.core.collections.SampleCollection.sync_last_modified_at

fiftyone.core.collections.SampleCollection.html#sync_last_modified_at

Function

Method

PUBLIC

Syncs the last_modified_at property(s) of the dataset.
fiftyone.core.collections.SampleCollection._sync_samples_last_modified_at

fiftyone.core.collections.SampleCollection.html#_sync_samples_last_modified_at

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._sync_dataset_last_modified_at

fiftyone.core.collections.SampleCollection.html#_sync_dataset_last_modified_at

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._min

fiftyone.core.collections.SampleCollection.html#_min

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._max

fiftyone.core.collections.SampleCollection.html#_max

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_extremum

fiftyone.core.collections.SampleCollection.html#_get_extremum

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection.stats

fiftyone.core.collections.SampleCollection.html#stats

Function

Method

PUBLIC

Returns stats about the collection on disk.
fiftyone.core.collections.SampleCollection._get_samples_bytes

fiftyone.core.collections.SampleCollection.html#_get_samples_bytes

Function

Method

PRIVATE

Computes the total size of the sample documents in the collection.
fiftyone.core.collections.SampleCollection._get_frames_bytes

fiftyone.core.collections.SampleCollection.html#_get_frames_bytes

Function

Method

PRIVATE

Computes the total size of the frame documents in the collection.
fiftyone.core.collections.SampleCollection._get_per_sample_bytes

fiftyone.core.collections.SampleCollection.html#_get_per_sample_bytes

Function

Method

PRIVATE

Returns a dictionary mapping sample IDs to document sizes (in bytes) for each sample in the collection.
fiftyone.core.collections.SampleCollection._get_per_frame_bytes

fiftyone.core.collections.SampleCollection.html#_get_per_frame_bytes

Function

Method

PRIVATE

Returns a dictionary mapping frame IDs to document sizes (in bytes) for each frame in the video collection.
fiftyone.core.collections.SampleCollection._get_per_sample_frames_bytes

fiftyone.core.collections.SampleCollection.html#_get_per_sample_frames_bytes

Function

Method

PRIVATE

Returns a dictionary mapping sample IDs to total frame document sizes (in bytes) for each sample in the video collection.
fiftyone.core.collections.SampleCollection.first

fiftyone.core.collections.SampleCollection.html#first

Function

Method

PUBLIC

Returns the first sample in the collection.
fiftyone.core.collections.SampleCollection.last

fiftyone.core.collections.SampleCollection.html#last

Function

Method

PUBLIC

Returns the last sample in the collection.
fiftyone.core.collections.SampleCollection.head

fiftyone.core.collections.SampleCollection.html#head

Function

Method

PUBLIC

Returns a list of the first few samples in the collection.
fiftyone.core.collections.SampleCollection.tail

fiftyone.core.collections.SampleCollection.html#tail

Function

Method

PUBLIC

Returns a list of the last few samples in the collection.
fiftyone.core.collections.SampleCollection.one

fiftyone.core.collections.SampleCollection.html#one

Function

Method

PUBLIC

Returns a single sample in this collection matching the expression.
fiftyone.core.collections.SampleCollection.view

fiftyone.core.collections.SampleCollection.html#view

Function

Method

PUBLIC

Returns a fiftyone.core.view.DatasetView containing the collection.
fiftyone.core.collections.SampleCollection.iter_samples

fiftyone.core.collections.SampleCollection.html#iter_samples

Function

Method

PUBLIC

Returns an iterator over the samples in the collection.
fiftyone.core.collections.SampleCollection.iter_groups

fiftyone.core.collections.SampleCollection.html#iter_groups

Function

Method

PUBLIC

Returns an iterator over the groups in the collection.
fiftyone.core.collections.SampleCollection.get_group

fiftyone.core.collections.SampleCollection.html#get_group

Function

Method

PUBLIC

Returns a dict containing the samples for the given group ID.
fiftyone.core.collections.SampleCollection.save_context

fiftyone.core.collections.SampleCollection.html#save_context

Function

Method

PUBLIC

Returns a context that can be used to save samples from this collection according to a configurable batching strategy.
fiftyone.core.collections.SampleCollection._get_default_sample_fields

fiftyone.core.collections.SampleCollection.html#_get_default_sample_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_default_frame_fields

fiftyone.core.collections.SampleCollection.html#_get_default_frame_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._is_default_field

fiftyone.core.collections.SampleCollection.html#_is_default_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._is_read_only_field

fiftyone.core.collections.SampleCollection.html#_is_read_only_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_default_field

fiftyone.core.collections.SampleCollection.html#_get_default_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection.get_field

fiftyone.core.collections.SampleCollection.html#get_field

Function

Method

PUBLIC

Returns the field instance of the provided path, or None if one does not exist.
fiftyone.core.collections.SampleCollection._parse_field

fiftyone.core.collections.SampleCollection.html#_parse_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection.get_field_schema

fiftyone.core.collections.SampleCollection.html#get_field_schema

Function

Method

PUBLIC

Returns a schema dictionary describing the fields of the samples in the collection.
fiftyone.core.collections.SampleCollection.get_frame_field_schema

fiftyone.core.collections.SampleCollection.html#get_frame_field_schema

Function

Method

PUBLIC

Returns a schema dictionary describing the fields of the frames in the collection.
fiftyone.core.collections.SampleCollection.get_dynamic_field_schema

fiftyone.core.collections.SampleCollection.html#get_dynamic_field_schema

Function

Method

PUBLIC

Returns a schema dictionary describing the dynamic fields of the samples in the collection.
fiftyone.core.collections.SampleCollection.get_dynamic_frame_field_schema

fiftyone.core.collections.SampleCollection.html#get_dynamic_frame_field_schema

Function

Method

PUBLIC

Returns a schema dictionary describing the dynamic fields of the frames in the collection.
fiftyone.core.collections.SampleCollection._get_dynamic_field_schema

fiftyone.core.collections.SampleCollection.html#_get_dynamic_field_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._do_get_dynamic_field_schema

fiftyone.core.collections.SampleCollection.html#_do_get_dynamic_field_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection.make_unique_field_name

fiftyone.core.collections.SampleCollection.html#make_unique_field_name

Function

Method

PUBLIC

Makes a unique field name with the given root name for the collection.
fiftyone.core.collections.SampleCollection.has_field

fiftyone.core.collections.SampleCollection.html#has_field

Function

Method

PUBLIC

Determines whether the collection has a field with the given name.
fiftyone.core.collections.SampleCollection.has_sample_field

fiftyone.core.collections.SampleCollection.html#has_sample_field

Function

Method

PUBLIC

Determines whether the collection has a sample field with the given name.
fiftyone.core.collections.SampleCollection.has_frame_field

fiftyone.core.collections.SampleCollection.html#has_frame_field

Function

Method

PUBLIC

Determines whether the collection has a frame-level field with the given name.
fiftyone.core.collections.SampleCollection.validate_fields_exist

fiftyone.core.collections.SampleCollection.html#validate_fields_exist

Function

Method

PUBLIC

Validates that the collection has field(s) with the given name(s).
fiftyone.core.collections.SampleCollection.validate_field_type

fiftyone.core.collections.SampleCollection.html#validate_field_type

Function

Method

PUBLIC

Validates that the collection has a field of the given type.
fiftyone.core.collections.SampleCollection.tag_samples

fiftyone.core.collections.SampleCollection.html#tag_samples

Function

Method

PUBLIC

Adds the tag(s) to all samples in this collection, if necessary.
fiftyone.core.collections.SampleCollection.untag_samples

fiftyone.core.collections.SampleCollection.html#untag_samples

Function

Method

PUBLIC

Removes the tag(s) from all samples in this collection, if necessary.
fiftyone.core.collections.SampleCollection._edit_sample_tags

fiftyone.core.collections.SampleCollection.html#_edit_sample_tags

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection.count_sample_tags

fiftyone.core.collections.SampleCollection.html#count_sample_tags

Function

Method

PUBLIC

Counts the occurrences of sample tags in this collection.
fiftyone.core.collections.SampleCollection.tag_labels

fiftyone.core.collections.SampleCollection.html#tag_labels

Function

Method

PUBLIC

Adds the tag(s) to all labels in the specified label field(s) of this collection, if necessary.
fiftyone.core.collections.SampleCollection._tag_labels

fiftyone.core.collections.SampleCollection.html#_tag_labels

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection.untag_labels

fiftyone.core.collections.SampleCollection.html#untag_labels

Function

Method

PUBLIC

Removes the tag from all labels in the specified label field(s) of this collection, if necessary.
fiftyone.core.collections.SampleCollection._untag_labels

fiftyone.core.collections.SampleCollection.html#_untag_labels

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._edit_label_tags

fiftyone.core.collections.SampleCollection.html#_edit_label_tags

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_selected_labels

fiftyone.core.collections.SampleCollection.html#_get_selected_labels

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_label_ids

fiftyone.core.collections.SampleCollection.html#_get_label_ids

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection.count_label_tags

fiftyone.core.collections.SampleCollection.html#count_label_tags

Function

Method

PUBLIC

Counts the occurrences of all label tags in the specified label field(s) of this collection.
fiftyone.core.collections.SampleCollection.split_labels

fiftyone.core.collections.SampleCollection.html#split_labels

Function

Method

PUBLIC

Splits the labels from the given input field into the given output field of the collection.
fiftyone.core.collections.SampleCollection.merge_labels

fiftyone.core.collections.SampleCollection.html#merge_labels

Function

Method

PUBLIC

Merges the labels from the given input field into the given output field of the collection.
fiftyone.core.collections.SampleCollection.set_values

fiftyone.core.collections.SampleCollection.html#set_values

Function

Method

PUBLIC

Sets the field or embedded field on each sample or frame in the collection to the given values.
fiftyone.core.collections.SampleCollection._set_values

fiftyone.core.collections.SampleCollection.html#_set_values

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection.set_label_values

fiftyone.core.collections.SampleCollection.html#set_label_values

Function

Method

PUBLIC

Sets the fields of the specified labels in the collection to the given values.
fiftyone.core.collections.SampleCollection._expand_schema_from_values

fiftyone.core.collections.SampleCollection.html#_expand_schema_from_values

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._set_sample_values

fiftyone.core.collections.SampleCollection.html#_set_sample_values

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._set_frame_values

fiftyone.core.collections.SampleCollection.html#_set_frame_values

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._set_doc_values

fiftyone.core.collections.SampleCollection.html#_set_doc_values

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._set_list_values_by_id

fiftyone.core.collections.SampleCollection.html#_set_list_values_by_id

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._set_label_list_values

fiftyone.core.collections.SampleCollection.html#_set_label_list_values

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._set_labels

fiftyone.core.collections.SampleCollection.html#_set_labels

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._delete_labels

fiftyone.core.collections.SampleCollection.html#_delete_labels

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection.compute_metadata

fiftyone.core.collections.SampleCollection.html#compute_metadata

Function

Method

PUBLIC

Populates the metadata field of all samples in the collection.
fiftyone.core.collections.SampleCollection.apply_model

fiftyone.core.collections.SampleCollection.html#apply_model

Function

Method

PUBLIC

Applies the model to the samples in the collection.
fiftyone.core.collections.SampleCollection.compute_embeddings

fiftyone.core.collections.SampleCollection.html#compute_embeddings

Function

Method

PUBLIC

Computes embeddings for the samples in the collection using the given model.
fiftyone.core.collections.SampleCollection.compute_patch_embeddings

fiftyone.core.collections.SampleCollection.html#compute_patch_embeddings

Function

Method

PUBLIC

Computes embeddings for the image patches defined by patches_field of the samples in the collection using the given model.
fiftyone.core.collections.SampleCollection.evaluate_regressions

fiftyone.core.collections.SampleCollection.html#evaluate_regressions

Function

Method

PUBLIC

Evaluates the regression predictions in this collection with respect to the specified ground truth values.
fiftyone.core.collections.SampleCollection.evaluate_classifications

fiftyone.core.collections.SampleCollection.html#evaluate_classifications

Function

Method

PUBLIC

Evaluates the classification predictions in this collection with respect to the specified ground truth labels.
fiftyone.core.collections.SampleCollection.evaluate_detections

fiftyone.core.collections.SampleCollection.html#evaluate_detections

Function

Method

PUBLIC

Evaluates the specified predicted detections in this collection with respect to the specified ground truth detections.
fiftyone.core.collections.SampleCollection.evaluate_segmentations

fiftyone.core.collections.SampleCollection.html#evaluate_segmentations

Function

Method

PUBLIC

Evaluates the specified semantic segmentation masks in this collection with respect to the specified ground truth masks.
fiftyone.core.collections.SampleCollection.has_evaluations

fiftyone.core.collections.SampleCollection.html#has_evaluations

Attribute

Property

PUBLIC

Whether this collection has any evaluation results.
fiftyone.core.collections.SampleCollection.has_evaluation

fiftyone.core.collections.SampleCollection.html#has_evaluation

Function

Method

PUBLIC

Whether this collection has an evaluation with the given key.
fiftyone.core.collections.SampleCollection.list_evaluations

fiftyone.core.collections.SampleCollection.html#list_evaluations

Function

Method

PUBLIC

Returns a list of evaluation keys on this collection.
fiftyone.core.collections.SampleCollection.rename_evaluation

fiftyone.core.collections.SampleCollection.html#rename_evaluation

Function

Method

PUBLIC

Replaces the key for the given evaluation with a new key.
fiftyone.core.collections.SampleCollection.get_evaluation_info

fiftyone.core.collections.SampleCollection.html#get_evaluation_info

Function

Method

PUBLIC

Returns information about the evaluation with the given key on this collection.
fiftyone.core.collections.SampleCollection.load_evaluation_results

fiftyone.core.collections.SampleCollection.html#load_evaluation_results

Function

Method

PUBLIC

Loads the results for the evaluation with the given key on this collection.
fiftyone.core.collections.SampleCollection.load_evaluation_view

fiftyone.core.collections.SampleCollection.html#load_evaluation_view

Function

Method

PUBLIC

Loads the fiftyone.core.view.DatasetView on which the specified evaluation was performed on this collection.
fiftyone.core.collections.SampleCollection.delete_evaluation

fiftyone.core.collections.SampleCollection.html#delete_evaluation

Function

Method

PUBLIC

Deletes the evaluation results associated with the given evaluation key from this collection.
fiftyone.core.collections.SampleCollection.delete_evaluations

fiftyone.core.collections.SampleCollection.html#delete_evaluations

Function

Method

PUBLIC

Deletes all evaluation results from this collection.
fiftyone.core.collections.SampleCollection.has_brain_runs

fiftyone.core.collections.SampleCollection.html#has_brain_runs

Attribute

Property

PUBLIC

Whether this collection has any brain runs.
fiftyone.core.collections.SampleCollection.has_brain_run

fiftyone.core.collections.SampleCollection.html#has_brain_run

Function

Method

PUBLIC

Whether this collection has a brain method run with the given key.
fiftyone.core.collections.SampleCollection.list_brain_runs

fiftyone.core.collections.SampleCollection.html#list_brain_runs

Function

Method

PUBLIC

Returns a list of brain keys on this collection.
fiftyone.core.collections.SampleCollection.rename_brain_run

fiftyone.core.collections.SampleCollection.html#rename_brain_run

Function

Method

PUBLIC

Replaces the key for the given brain run with a new key.
fiftyone.core.collections.SampleCollection.get_brain_info

fiftyone.core.collections.SampleCollection.html#get_brain_info

Function

Method

PUBLIC

Returns information about the brain method run with the given key on this collection.
fiftyone.core.collections.SampleCollection.load_brain_results

fiftyone.core.collections.SampleCollection.html#load_brain_results

Function

Method

PUBLIC

Loads the results for the brain method run with the given key on this collection.
fiftyone.core.collections.SampleCollection.load_brain_view

fiftyone.core.collections.SampleCollection.html#load_brain_view

Function

Method

PUBLIC

Loads the fiftyone.core.view.DatasetView on which the specified brain method run was performed on this collection.
fiftyone.core.collections.SampleCollection.delete_brain_run

fiftyone.core.collections.SampleCollection.html#delete_brain_run

Function

Method

PUBLIC

Deletes the brain method run with the given key from this collection.
fiftyone.core.collections.SampleCollection.delete_brain_runs

fiftyone.core.collections.SampleCollection.html#delete_brain_runs

Function

Method

PUBLIC

Deletes all brain method runs from this collection.
fiftyone.core.collections.SampleCollection.has_runs

fiftyone.core.collections.SampleCollection.html#has_runs

Attribute

Property

PUBLIC

Whether this collection has any runs.
fiftyone.core.collections.SampleCollection.has_run

fiftyone.core.collections.SampleCollection.html#has_run

Function

Method

PUBLIC

Whether this collection has a run with the given key.
fiftyone.core.collections.SampleCollection.list_runs

fiftyone.core.collections.SampleCollection.html#list_runs

Function

Method

PUBLIC

Returns a list of run keys on this collection.
fiftyone.core.collections.SampleCollection.init_run

fiftyone.core.collections.SampleCollection.html#init_run

Function

Method

PUBLIC

Initializes a config instance for a new run.
fiftyone.core.collections.SampleCollection.register_run

fiftyone.core.collections.SampleCollection.html#register_run

Function

Method

PUBLIC

Registers a run under the given key on this collection.
fiftyone.core.collections.SampleCollection.rename_run

fiftyone.core.collections.SampleCollection.html#rename_run

Function

Method

PUBLIC

Replaces the key for the given run with a new key.
fiftyone.core.collections.SampleCollection.get_run_info

fiftyone.core.collections.SampleCollection.html#get_run_info

Function

Method

PUBLIC

Returns information about the run with the given key on this collection.
fiftyone.core.collections.SampleCollection.update_run_config

fiftyone.core.collections.SampleCollection.html#update_run_config

Function

Method

PUBLIC

Updates the run config for the run with the given key.
fiftyone.core.collections.SampleCollection.init_run_results

fiftyone.core.collections.SampleCollection.html#init_run_results

Function

Method

PUBLIC

Initializes a results instance for the run with the given key.
fiftyone.core.collections.SampleCollection.save_run_results

fiftyone.core.collections.SampleCollection.html#save_run_results

Function

Method

PUBLIC

Saves run results for the run with the given key.
fiftyone.core.collections.SampleCollection.load_run_results

fiftyone.core.collections.SampleCollection.html#load_run_results

Function

Method

PUBLIC

Loads the results for the run with the given key on this collection.
fiftyone.core.collections.SampleCollection.load_run_view

fiftyone.core.collections.SampleCollection.html#load_run_view

Function

Method

PUBLIC

Loads the fiftyone.core.view.DatasetView on which the specified run was performed on this collection.
fiftyone.core.collections.SampleCollection.delete_run

fiftyone.core.collections.SampleCollection.html#delete_run

Function

Method

PUBLIC

Deletes the run with the given key from this collection.
fiftyone.core.collections.SampleCollection.delete_runs

fiftyone.core.collections.SampleCollection.html#delete_runs

Function

Method

PUBLIC

Deletes all runs from this collection.
fiftyone.core.collections.SampleCollection.list_view_stages

fiftyone.core.collections.SampleCollection.html#list_view_stages

Function

Class Method

PUBLIC

Returns a list of all available methods on this collection that apply fiftyone.core.stages.ViewStage operations to this collection.
fiftyone.core.collections.SampleCollection.add_stage

fiftyone.core.collections.SampleCollection.html#add_stage

Function

Method

PUBLIC

Applies the given fiftyone.core.stages.ViewStage to the collection.
fiftyone.core.collections.SampleCollection.concat

fiftyone.core.collections.SampleCollection.html#concat

Function

Method

PUBLIC

Concatenates the contents of the given SampleCollection to this collection.
fiftyone.core.collections.SampleCollection.exclude

fiftyone.core.collections.SampleCollection.html#exclude

Function

Method

PUBLIC

Excludes the samples with the given IDs from the collection.
fiftyone.core.collections.SampleCollection.exclude_by

fiftyone.core.collections.SampleCollection.html#exclude_by

Function

Method

PUBLIC

Excludes the samples with the given field values from the collection.
fiftyone.core.collections.SampleCollection.exclude_fields

fiftyone.core.collections.SampleCollection.html#exclude_fields

Function

Method

PUBLIC

Excludes the fields with the given names from the samples in the collection.
fiftyone.core.collections.SampleCollection.exclude_frames

fiftyone.core.collections.SampleCollection.html#exclude_frames

Function

Method

PUBLIC

Excludes the frames with the given IDs from the video collection.
fiftyone.core.collections.SampleCollection.exclude_groups

fiftyone.core.collections.SampleCollection.html#exclude_groups

Function

Method

PUBLIC

Excludes the groups with the given IDs from the grouped collection.
fiftyone.core.collections.SampleCollection.exclude_labels

fiftyone.core.collections.SampleCollection.html#exclude_labels

Function

Method

PUBLIC

Excludes the specified labels from the collection.
fiftyone.core.collections.SampleCollection.exists

fiftyone.core.collections.SampleCollection.html#exists

Function

Method

PUBLIC

Returns a view containing the samples in the collection that have (or do not have) a non-None value for the given field or embedded field.
fiftyone.core.collections.SampleCollection.filter_field

fiftyone.core.collections.SampleCollection.html#filter_field

Function

Method

PUBLIC

Filters the values of a field or embedded field of each sample in the collection.
fiftyone.core.collections.SampleCollection.filter_labels

fiftyone.core.collections.SampleCollection.html#filter_labels

Function

Method

PUBLIC

Filters the fiftyone.core.labels.Label field of each sample in the collection.
fiftyone.core.collections.SampleCollection.filter_keypoints

fiftyone.core.collections.SampleCollection.html#filter_keypoints

Function

Method

PUBLIC

Filters the individual fiftyone.core.labels.Keypoint.points elements in the specified keypoints field of each sample in the collection.
fiftyone.core.collections.SampleCollection.flatten

fiftyone.core.collections.SampleCollection.html#flatten

Function

Method

PUBLIC

Returns a flattened view that contains all samples in the dynamic grouped collection.
fiftyone.core.collections.SampleCollection.geo_near

fiftyone.core.collections.SampleCollection.html#geo_near

Function

Method

PUBLIC

Sorts the samples in the collection by their proximity to a specified geolocation.
fiftyone.core.collections.SampleCollection.geo_within

fiftyone.core.collections.SampleCollection.html#geo_within

Function

Method

PUBLIC

Filters the samples in this collection to only include samples whose geolocation is within a specified boundary.
fiftyone.core.collections.SampleCollection.group_by

fiftyone.core.collections.SampleCollection.html#group_by

Function

Method

PUBLIC

Creates a view that groups the samples in the collection by a specified field or expression.
fiftyone.core.collections.SampleCollection.limit

fiftyone.core.collections.SampleCollection.html#limit

Function

Method

PUBLIC

Returns a view with at most the given number of samples.
fiftyone.core.collections.SampleCollection.limit_labels

fiftyone.core.collections.SampleCollection.html#limit_labels

Function

Method

PUBLIC

Limits the number of fiftyone.core.labels.Label instances in the specified labels list field of each sample in the collection.
fiftyone.core.collections.SampleCollection.map_labels

fiftyone.core.collections.SampleCollection.html#map_labels

Function

Method

PUBLIC

Maps the label values of a fiftyone.core.labels.Label field to new values for each sample in the collection.
fiftyone.core.collections.SampleCollection.set_field

fiftyone.core.collections.SampleCollection.html#set_field

Function

Method

PUBLIC

Sets a field or embedded field on each sample in a collection by evaluating the given expression.
fiftyone.core.collections.SampleCollection.match

fiftyone.core.collections.SampleCollection.html#match

Function

Method

PUBLIC

Filters the samples in the collection by the given filter.
fiftyone.core.collections.SampleCollection.match_frames

fiftyone.core.collections.SampleCollection.html#match_frames

Function

Method

PUBLIC

Filters the frames in the video collection by the given filter.
fiftyone.core.collections.SampleCollection.match_labels

fiftyone.core.collections.SampleCollection.html#match_labels

Function

Method

PUBLIC

Selects the samples from the collection that contain (or do not contain) at least one label that matches the specified criteria.
fiftyone.core.collections.SampleCollection.match_tags

fiftyone.core.collections.SampleCollection.html#match_tags

Function

Method

PUBLIC

Returns a view containing the samples in the collection that have or don't have any/all of the given tag(s).
fiftyone.core.collections.SampleCollection.mongo

fiftyone.core.collections.SampleCollection.html#mongo

Function

Method

PUBLIC

Adds a view stage defined by a raw MongoDB aggregation pipeline.
fiftyone.core.collections.SampleCollection.select

fiftyone.core.collections.SampleCollection.html#select

Function

Method

PUBLIC

Selects the samples with the given IDs from the collection.
fiftyone.core.collections.SampleCollection.select_by

fiftyone.core.collections.SampleCollection.html#select_by

Function

Method

PUBLIC

Selects the samples with the given field values from the collection.
fiftyone.core.collections.SampleCollection.select_fields

fiftyone.core.collections.SampleCollection.html#select_fields

Function

Method

PUBLIC

Selects only the fields with the given names from the samples in the collection. All other fields are excluded.
fiftyone.core.collections.SampleCollection.select_frames

fiftyone.core.collections.SampleCollection.html#select_frames

Function

Method

PUBLIC

Selects the frames with the given IDs from the video collection.
fiftyone.core.collections.SampleCollection.select_groups

fiftyone.core.collections.SampleCollection.html#select_groups

Function

Method

PUBLIC

Selects the groups with the given IDs from the grouped collection.
fiftyone.core.collections.SampleCollection.select_group_slices

fiftyone.core.collections.SampleCollection.html#select_group_slices

Function

Method

PUBLIC

Selects the samples in the group collection from the given slice(s).
fiftyone.core.collections.SampleCollection.select_labels

fiftyone.core.collections.SampleCollection.html#select_labels

Function

Method

PUBLIC

Selects only the specified labels from the collection.
fiftyone.core.collections.SampleCollection.shuffle

fiftyone.core.collections.SampleCollection.html#shuffle

Function

Method

PUBLIC

Randomly shuffles the samples in the collection.
fiftyone.core.collections.SampleCollection.skip

fiftyone.core.collections.SampleCollection.html#skip

Function

Method

PUBLIC

Omits the given number of samples from the head of the collection.
fiftyone.core.collections.SampleCollection.sort_by

fiftyone.core.collections.SampleCollection.html#sort_by

Function

Method

PUBLIC

Sorts the samples in the collection by the given field(s) or expression(s).
fiftyone.core.collections.SampleCollection.sort_by_similarity

fiftyone.core.collections.SampleCollection.html#sort_by_similarity

Function

Method

PUBLIC

Sorts the collection by similarity to a specified query.
fiftyone.core.collections.SampleCollection.take

fiftyone.core.collections.SampleCollection.html#take

Function

Method

PUBLIC

Randomly samples the given number of samples from the collection.
fiftyone.core.collections.SampleCollection.to_patches

fiftyone.core.collections.SampleCollection.html#to_patches

Function

Method

PUBLIC

Creates a view that contains one sample per object patch in the specified field of the collection.
fiftyone.core.collections.SampleCollection.to_evaluation_patches

fiftyone.core.collections.SampleCollection.html#to_evaluation_patches

Function

Method

PUBLIC

Creates a view based on the results of the evaluation with the given key that contains one sample for each true positive, false positive, and false negative example in the collection, respectively.
fiftyone.core.collections.SampleCollection.to_clips

fiftyone.core.collections.SampleCollection.html#to_clips

Function

Method

PUBLIC

Creates a view that contains one sample per clip defined by the given field or expression in the video collection.
fiftyone.core.collections.SampleCollection.to_trajectories

fiftyone.core.collections.SampleCollection.html#to_trajectories

Function

Method

PUBLIC

Creates a view that contains one clip for each unique object trajectory defined by their (label, index) in a frame-level field of a video collection.
fiftyone.core.collections.SampleCollection.to_frames

fiftyone.core.collections.SampleCollection.html#to_frames

Function

Method

PUBLIC

Creates a view that contains one sample per frame in the video collection.
fiftyone.core.collections.SampleCollection.list_aggregations

fiftyone.core.collections.SampleCollection.html#list_aggregations

Function

Class Method

PUBLIC

Returns a list of all available methods on this collection that apply fiftyone.core.aggregations.Aggregation operations to this collection.
fiftyone.core.collections.SampleCollection.bounds

fiftyone.core.collections.SampleCollection.html#bounds

Function

Method

PUBLIC

Computes the bounds of a numeric field of the collection.
fiftyone.core.collections.SampleCollection.count

fiftyone.core.collections.SampleCollection.html#count

Function

Method

PUBLIC

Counts the number of field values in the collection.
fiftyone.core.collections.SampleCollection.count_values

fiftyone.core.collections.SampleCollection.html#count_values

Function

Method

PUBLIC

Counts the occurrences of field values in the collection.
fiftyone.core.collections.SampleCollection.distinct

fiftyone.core.collections.SampleCollection.html#distinct

Function

Method

PUBLIC

Computes the distinct values of a field in the collection.
fiftyone.core.collections.SampleCollection.histogram_values

fiftyone.core.collections.SampleCollection.html#histogram_values

Function

Method

PUBLIC

Computes a histogram of the field values in the collection.
fiftyone.core.collections.SampleCollection.min

fiftyone.core.collections.SampleCollection.html#min

Function

Method

PUBLIC

Computes the minimum of a numeric field of the collection.
fiftyone.core.collections.SampleCollection.max

fiftyone.core.collections.SampleCollection.html#max

Function

Method

PUBLIC

Computes the maximum of a numeric field of the collection.
fiftyone.core.collections.SampleCollection.mean

fiftyone.core.collections.SampleCollection.html#mean

Function

Method

PUBLIC

Computes the arithmetic mean of the field values of the collection.
fiftyone.core.collections.SampleCollection.quantiles

fiftyone.core.collections.SampleCollection.html#quantiles

Function

Method

PUBLIC

Computes the quantile(s) of the field values of a collection.
fiftyone.core.collections.SampleCollection.schema

fiftyone.core.collections.SampleCollection.html#schema

Function

Method

PUBLIC

Extracts the names and types of the attributes of a specified embedded document field across all samples in the collection.
fiftyone.core.collections.SampleCollection.list_schema

fiftyone.core.collections.SampleCollection.html#list_schema

Function

Method

PUBLIC

Extracts the value type(s) in a specified list field across all samples in the collection.
fiftyone.core.collections.SampleCollection.std

fiftyone.core.collections.SampleCollection.html#std

Function

Method

PUBLIC

Computes the standard deviation of the field values of the collection.
fiftyone.core.collections.SampleCollection.sum

fiftyone.core.collections.SampleCollection.html#sum

Function

Method

PUBLIC

Computes the sum of the field values of the collection.
fiftyone.core.collections.SampleCollection.values

fiftyone.core.collections.SampleCollection.html#values

Function

Method

PUBLIC

Extracts the values of a field from all samples in the collection.
fiftyone.core.collections.SampleCollection.draw_labels

fiftyone.core.collections.SampleCollection.html#draw_labels

Function

Method

PUBLIC

Renders annotated versions of the media in the collection with the specified label data overlaid to the given directory.
fiftyone.core.collections.SampleCollection.export

fiftyone.core.collections.SampleCollection.html#export

Function

Method

PUBLIC

Exports the samples in the collection to disk.
fiftyone.core.collections.SampleCollection.annotate

fiftyone.core.collections.SampleCollection.html#annotate

Function

Method

PUBLIC

Exports the samples and optional label field(s) in this collection to the given annotation backend.
fiftyone.core.collections.SampleCollection.has_annotation_runs

fiftyone.core.collections.SampleCollection.html#has_annotation_runs

Attribute

Property

PUBLIC

Whether this collection has any annotation runs.
fiftyone.core.collections.SampleCollection.has_annotation_run

fiftyone.core.collections.SampleCollection.html#has_annotation_run

Function

Method

PUBLIC

Whether this collection has an annotation run with the given key.
fiftyone.core.collections.SampleCollection.list_annotation_runs

fiftyone.core.collections.SampleCollection.html#list_annotation_runs

Function

Method

PUBLIC

Returns a list of annotation keys on this collection.
fiftyone.core.collections.SampleCollection.rename_annotation_run

fiftyone.core.collections.SampleCollection.html#rename_annotation_run

Function

Method

PUBLIC

Replaces the key for the given annotation run with a new key.
fiftyone.core.collections.SampleCollection.get_annotation_info

fiftyone.core.collections.SampleCollection.html#get_annotation_info

Function

Method

PUBLIC

Returns information about the annotation run with the given key on this collection.
fiftyone.core.collections.SampleCollection.load_annotation_results

fiftyone.core.collections.SampleCollection.html#load_annotation_results

Function

Method

PUBLIC

Loads the results for the annotation run with the given key on this collection.
fiftyone.core.collections.SampleCollection.load_annotation_view

fiftyone.core.collections.SampleCollection.html#load_annotation_view

Function

Method

PUBLIC

Loads the fiftyone.core.view.DatasetView on which the specified annotation run was performed on this collection.
fiftyone.core.collections.SampleCollection.load_annotations

fiftyone.core.collections.SampleCollection.html#load_annotations

Function

Method

PUBLIC

Downloads the labels from the given annotation run from the annotation backend and merges them into this collection.
fiftyone.core.collections.SampleCollection.delete_annotation_run

fiftyone.core.collections.SampleCollection.html#delete_annotation_run

Function

Method

PUBLIC

Deletes the annotation run with the given key from this collection.
fiftyone.core.collections.SampleCollection.delete_annotation_runs

fiftyone.core.collections.SampleCollection.html#delete_annotation_runs

Function

Method

PUBLIC

Deletes all annotation runs from this collection.
fiftyone.core.collections.SampleCollection.list_indexes

fiftyone.core.collections.SampleCollection.html#list_indexes

Function

Method

PUBLIC

Returns the list of index names on this collection.
fiftyone.core.collections.SampleCollection.get_index_information

fiftyone.core.collections.SampleCollection.html#get_index_information

Function

Method

PUBLIC

Returns a dictionary of information about the indexes on this collection.
fiftyone.core.collections.SampleCollection.create_index

fiftyone.core.collections.SampleCollection.html#create_index

Function

Method

PUBLIC

Creates an index on the given field or with the given specification, if necessary.
fiftyone.core.collections.SampleCollection.drop_index

fiftyone.core.collections.SampleCollection.html#drop_index

Function

Method

PUBLIC

Drops the index for the given field or name, if necessary.
fiftyone.core.collections.SampleCollection._get_default_indexes

fiftyone.core.collections.SampleCollection.html#_get_default_indexes

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection.reload

fiftyone.core.collections.SampleCollection.html#reload

Function

Method

PUBLIC

Reloads the collection from the database.
fiftyone.core.collections.SampleCollection.to_dict

fiftyone.core.collections.SampleCollection.html#to_dict

Function

Method

PUBLIC

Returns a JSON dictionary representation of the collection.
fiftyone.core.collections.SampleCollection.to_json

fiftyone.core.collections.SampleCollection.html#to_json

Function

Method

PUBLIC

Returns a JSON string representation of the collection.
fiftyone.core.collections.SampleCollection.write_json

fiftyone.core.collections.SampleCollection.html#write_json

Function

Method

PUBLIC

Writes the colllection to disk in JSON format.
fiftyone.core.collections.SampleCollection._add_view_stage

fiftyone.core.collections.SampleCollection.html#_add_view_stage

Function

Method

PRIVATE

Returns a fiftyone.core.view.DatasetView containing the contents of the collection with the given fiftyone.core.stages.ViewStage` appended to its aggregation pipeline.
fiftyone.core.collections.SampleCollection.aggregate

fiftyone.core.collections.SampleCollection.html#aggregate

Function

Method

PUBLIC

Aggregates one or more fiftyone.core.aggregations.Aggregation instances.
fiftyone.core.collections.SampleCollection._async_aggregate

fiftyone.core.collections.SampleCollection.html#_async_aggregate

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._parse_aggregations

fiftyone.core.collections.SampleCollection.html#_parse_aggregations

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._build_batch_pipeline

fiftyone.core.collections.SampleCollection.html#_build_batch_pipeline

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._build_big_pipeline

fiftyone.core.collections.SampleCollection.html#_build_big_pipeline

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._build_facets

fiftyone.core.collections.SampleCollection.html#_build_facets

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._parse_big_result

fiftyone.core.collections.SampleCollection.html#_parse_big_result

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._parse_faceted_result

fiftyone.core.collections.SampleCollection.html#_parse_faceted_result

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._pipeline

fiftyone.core.collections.SampleCollection.html#_pipeline

Function

Method

PRIVATE

Returns the MongoDB aggregation pipeline for the collection.
fiftyone.core.collections.SampleCollection._aggregate

fiftyone.core.collections.SampleCollection.html#_aggregate

Function

Method

PRIVATE

Runs the MongoDB aggregation pipeline on the collection and returns the result.
fiftyone.core.collections.SampleCollection._make_and_aggregate

fiftyone.core.collections.SampleCollection.html#_make_and_aggregate

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._build_aggregation

fiftyone.core.collections.SampleCollection.html#_build_aggregation

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._process_aggregations

fiftyone.core.collections.SampleCollection.html#_process_aggregations

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._serialize

fiftyone.core.collections.SampleCollection.html#_serialize

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._serialize_field_schema

fiftyone.core.collections.SampleCollection.html#_serialize_field_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._serialize_frame_field_schema

fiftyone.core.collections.SampleCollection.html#_serialize_frame_field_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._serialize_schema

fiftyone.core.collections.SampleCollection.html#_serialize_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._serialize_mask_targets

fiftyone.core.collections.SampleCollection.html#_serialize_mask_targets

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._serialize_default_mask_targets

fiftyone.core.collections.SampleCollection.html#_serialize_default_mask_targets

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._parse_mask_targets

fiftyone.core.collections.SampleCollection.html#_parse_mask_targets

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._parse_default_mask_targets

fiftyone.core.collections.SampleCollection.html#_parse_default_mask_targets

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._serialize_skeletons

fiftyone.core.collections.SampleCollection.html#_serialize_skeletons

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._serialize_default_skeleton

fiftyone.core.collections.SampleCollection.html#_serialize_default_skeleton

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._parse_skeletons

fiftyone.core.collections.SampleCollection.html#_parse_skeletons

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._parse_default_skeleton

fiftyone.core.collections.SampleCollection.html#_parse_default_skeleton

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._to_fields_str

fiftyone.core.collections.SampleCollection.html#_to_fields_str

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._split_frame_fields

fiftyone.core.collections.SampleCollection.html#_split_frame_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._parse_field_name

fiftyone.core.collections.SampleCollection.html#_parse_field_name

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._has_field

fiftyone.core.collections.SampleCollection.html#_has_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._handle_frame_field

fiftyone.core.collections.SampleCollection.html#_handle_frame_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._is_frame_field

fiftyone.core.collections.SampleCollection.html#_is_frame_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._handle_group_field

fiftyone.core.collections.SampleCollection.html#_handle_group_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._is_group_field

fiftyone.core.collections.SampleCollection.html#_is_group_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_group_slices

fiftyone.core.collections.SampleCollection.html#_get_group_slices

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_group_media_types

fiftyone.core.collections.SampleCollection.html#_get_group_media_types

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._contains_media_type

fiftyone.core.collections.SampleCollection.html#_contains_media_type

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._contains_videos

fiftyone.core.collections.SampleCollection.html#_contains_videos

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._has_frame_fields

fiftyone.core.collections.SampleCollection.html#_has_frame_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._handle_id_fields

fiftyone.core.collections.SampleCollection.html#_handle_id_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._is_full_collection

fiftyone.core.collections.SampleCollection.html#_is_full_collection

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._is_label_field

fiftyone.core.collections.SampleCollection.html#_is_label_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._parse_label_field

fiftyone.core.collections.SampleCollection.html#_parse_label_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._parse_frame_labels_field

fiftyone.core.collections.SampleCollection.html#_parse_frame_labels_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_db_fields_map

fiftyone.core.collections.SampleCollection.html#_get_db_fields_map

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._handle_db_field

fiftyone.core.collections.SampleCollection.html#_handle_db_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._handle_db_fields

fiftyone.core.collections.SampleCollection.html#_handle_db_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_media_fields

fiftyone.core.collections.SampleCollection.html#_get_media_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._parse_media_field

fiftyone.core.collections.SampleCollection.html#_parse_media_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_label_fields

fiftyone.core.collections.SampleCollection.html#_get_label_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_label_field_schema

fiftyone.core.collections.SampleCollection.html#_get_label_field_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_frame_label_field_schema

fiftyone.core.collections.SampleCollection.html#_get_frame_label_field_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_root_fields

fiftyone.core.collections.SampleCollection.html#_get_root_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._validate_root_field

fiftyone.core.collections.SampleCollection.html#_validate_root_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_root_field_type

fiftyone.core.collections.SampleCollection.html#_get_root_field_type

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_label_field_type

fiftyone.core.collections.SampleCollection.html#_get_label_field_type

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_label_field_root

fiftyone.core.collections.SampleCollection.html#_get_label_field_root

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_label_field_path

fiftyone.core.collections.SampleCollection.html#_get_label_field_path

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_geo_location_field

fiftyone.core.collections.SampleCollection.html#_get_geo_location_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_label_attributes_schema

fiftyone.core.collections.SampleCollection.html#_get_label_attributes_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._unwind_values

fiftyone.core.collections.SampleCollection.html#_unwind_values

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._make_set_field_pipeline

fiftyone.core.collections.SampleCollection.html#_make_set_field_pipeline

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_values_by_id

fiftyone.core.collections.SampleCollection.html#_get_values_by_id

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._has_stores

fiftyone.core.collections.SampleCollection.html#_has_stores

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._list_stores

fiftyone.core.collections.SampleCollection.html#_list_stores

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections.SampleCollection._get_store

fiftyone.core.collections.SampleCollection.html#_get_store

Function

Method

PRIVATE

Undocumented
fiftyone.core.collections._iter_label_fields

fiftyone.core.collections.html#_iter_label_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._iter_schema_label_fields

fiftyone.core.collections.html#_iter_schema_label_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._serialize_value

fiftyone.core.collections.html#_serialize_value

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._unwind_values

fiftyone.core.collections.html#_unwind_values

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._parse_label_field

fiftyone.core.collections.html#_parse_label_field

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._parse_frame_labels_field

fiftyone.core.collections.html#_parse_frame_labels_field

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._is_glob_pattern

fiftyone.core.collections.html#_is_glob_pattern

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._get_matching_label_fields

fiftyone.core.collections.html#_get_matching_label_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._get_default_label_fields_for_exporter

fiftyone.core.collections.html#_get_default_label_fields_for_exporter

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._get_default_frame_label_fields_for_exporter

fiftyone.core.collections.html#_get_default_frame_label_fields_for_exporter

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._get_fields_with_types

fiftyone.core.collections.html#_get_fields_with_types

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._get_field_with_type

fiftyone.core.collections.html#_get_field_with_type

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._get_matching_label_field

fiftyone.core.collections.html#_get_matching_label_field

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._parse_values_dict

fiftyone.core.collections.html#_parse_values_dict

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._parse_frame_values_dicts

fiftyone.core.collections.html#_parse_frame_values_dicts

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._parse_field_name

fiftyone.core.collections.html#_parse_field_name

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._handle_id_field

fiftyone.core.collections.html#_handle_id_field

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._handle_id_fields

fiftyone.core.collections.html#_handle_id_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._transform_values

fiftyone.core.collections.html#_transform_values

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._make_set_field_pipeline

fiftyone.core.collections.html#_make_set_field_pipeline

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._set_terminal_list_field

fiftyone.core.collections.html#_set_terminal_list_field

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._render_expr

fiftyone.core.collections.html#_render_expr

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._get_random_characters

fiftyone.core.collections.html#_get_random_characters

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._get_non_none_value

fiftyone.core.collections.html#_get_non_none_value

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._export

fiftyone.core.collections.html#_export

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._parse_frame_label_fields

fiftyone.core.collections.html#_parse_frame_label_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._to_label_fields_dict

fiftyone.core.collections.html#_to_label_fields_dict

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._finalize_label_fields

fiftyone.core.collections.html#_finalize_label_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._handle_existing_dirs

fiftyone.core.collections.html#_handle_existing_dirs

Function

Function

PRIVATE

Undocumented
fiftyone.core.collections._add_db_fields_to_schema

fiftyone.core.collections.html#_add_db_fields_to_schema

Function

Function

PRIVATE

Undocumented
fiftyone.core.fields.validate_constraints

fiftyone.core.fields.html#validate_constraints

Function

Function

PUBLIC

Validates the given field constraints.
fiftyone.core.fields.matches_constraints

fiftyone.core.fields.html#matches_constraints

Function

Function

PUBLIC

Determines whether the field matches the given constraints.
fiftyone.core.fields.validate_field

fiftyone.core.fields.html#validate_field

Function

Function

PUBLIC

Validates that the field matches the given constraints.
fiftyone.core.fields._make_prefix

fiftyone.core.fields.html#_make_prefix

Function

Function

PRIVATE

Undocumented
fiftyone.core.fields.get_field_metadata

fiftyone.core.fields.html#get_field_metadata

Function

Function

PUBLIC

Returns a dict of editable metadata for the given field.
fiftyone.core.fields._SUPPORTED_MODES

fiftyone.core.fields.html#_SUPPORTED_MODES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.fields.filter_schema

fiftyone.core.fields.html#filter_schema

Function

Function

PUBLIC

Filters the schema according to the given constraints.
fiftyone.core.fields.flatten_schema

fiftyone.core.fields.html#flatten_schema

Function

Function

PUBLIC

Returns a flat version of the given schema where all embedded document fields are included as top-level keys.
fiftyone.core.fields._flatten

fiftyone.core.fields.html#_flatten

Function

Function

PRIVATE

Undocumented
fiftyone.core.fields.Field

fiftyone.core.fields.Field.html

Class

Class

PUBLIC

A generic field.
fiftyone.core.fields.Field.__init__

fiftyone.core.fields.Field.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.Field._description

fiftyone.core.fields.Field.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.Field._info

fiftyone.core.fields.Field.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.Field._read_only

fiftyone.core.fields.Field.html#_read_only

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.Field._created_at

fiftyone.core.fields.Field.html#_created_at

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.Field.__dataset

fiftyone.core.fields.Field.html#__dataset

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.Field.__path

fiftyone.core.fields.Field.html#__path

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.Field.__str__

fiftyone.core.fields.Field.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.Field._set_created_at

fiftyone.core.fields.Field.html#_set_created_at

Function

Method

PRIVATE

Undocumented
fiftyone.core.fields.Field._set_dataset

fiftyone.core.fields.Field.html#_set_dataset

Function

Method

PRIVATE

Undocumented
fiftyone.core.fields.Field._dataset

fiftyone.core.fields.Field.html#_dataset

Attribute

Property

PRIVATE

The fiftyone.core.dataset.Dataset that this field belongs to, or None if the field is not associated with a dataset.
fiftyone.core.fields.Field.path

fiftyone.core.fields.Field.html#path

Attribute

Property

PUBLIC

The fully-qualified path of this field in the dataset's schema, or None if the field is not associated with a dataset.
fiftyone.core.fields.Field.description

fiftyone.core.fields.Field.html#description

Attribute

Property

PUBLIC

A user-editable description of the field.
fiftyone.core.fields.Field.description.setter

fiftyone.core.fields.Field.html#description.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.Field.info

fiftyone.core.fields.Field.html#info

Attribute

Property

PUBLIC

A user-editable dictionary of information about the field.
fiftyone.core.fields.Field.info.setter

fiftyone.core.fields.Field.html#info.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.Field.read_only

fiftyone.core.fields.Field.html#read_only

Attribute

Property

PUBLIC

Whether the field is read-only.
fiftyone.core.fields.Field.read_only.setter

fiftyone.core.fields.Field.html#read_only.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.Field.created_at

fiftyone.core.fields.Field.html#created_at

Attribute

Property

PUBLIC

The datetime the field was created.
fiftyone.core.fields.Field.copy

fiftyone.core.fields.Field.html#copy

Function

Method

PUBLIC

Returns a copy of the field.
fiftyone.core.fields.Field.save

fiftyone.core.fields.Field.html#save

Function

Method

PUBLIC

Saves any edits to this field's description and info attributes.
fiftyone.core.fields.IntField

fiftyone.core.fields.IntField.html

Class

Class

PUBLIC

A 32 bit integer field.
fiftyone.core.fields.IntField.__init__

fiftyone.core.fields.IntField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.IntField._description

fiftyone.core.fields.IntField.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.IntField._info

fiftyone.core.fields.IntField.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.IntField._read_only

fiftyone.core.fields.IntField.html#_read_only

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.IntField._created_at

fiftyone.core.fields.IntField.html#_created_at

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.IntField.to_mongo

fiftyone.core.fields.IntField.html#to_mongo

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.ObjectIdField

fiftyone.core.fields.ObjectIdField.html

Class

Class

PUBLIC

An Object ID field.
fiftyone.core.fields.ObjectIdField.__init__

fiftyone.core.fields.ObjectIdField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.ObjectIdField._description

fiftyone.core.fields.ObjectIdField.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.ObjectIdField._info

fiftyone.core.fields.ObjectIdField.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.ObjectIdField._read_only

fiftyone.core.fields.ObjectIdField.html#_read_only

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.ObjectIdField._created_at

fiftyone.core.fields.ObjectIdField.html#_created_at

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.ObjectIdField.to_mongo

fiftyone.core.fields.ObjectIdField.html#to_mongo

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.ObjectIdField.to_python

fiftyone.core.fields.ObjectIdField.html#to_python

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.UUIDField

fiftyone.core.fields.UUIDField.html

Class

Class

PUBLIC

A UUID field.
fiftyone.core.fields.UUIDField.__init__

fiftyone.core.fields.UUIDField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.UUIDField._description

fiftyone.core.fields.UUIDField.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.UUIDField._info

fiftyone.core.fields.UUIDField.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.UUIDField._read_only

fiftyone.core.fields.UUIDField.html#_read_only

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.UUIDField._created_at

fiftyone.core.fields.UUIDField.html#_created_at

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.BooleanField

fiftyone.core.fields.BooleanField.html

Class

Class

PUBLIC

A boolean field.
fiftyone.core.fields.BooleanField.__init__

fiftyone.core.fields.BooleanField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.BooleanField._description

fiftyone.core.fields.BooleanField.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.BooleanField._info

fiftyone.core.fields.BooleanField.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.BooleanField._read_only

fiftyone.core.fields.BooleanField.html#_read_only

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.BooleanField._created_at

fiftyone.core.fields.BooleanField.html#_created_at

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.BooleanField.validate

fiftyone.core.fields.BooleanField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.DateField

fiftyone.core.fields.DateField.html

Class

Class

PUBLIC

A date field.
fiftyone.core.fields.DateField.__init__

fiftyone.core.fields.DateField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.DateField._description

fiftyone.core.fields.DateField.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.DateField._info

fiftyone.core.fields.DateField.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.DateField._read_only

fiftyone.core.fields.DateField.html#_read_only

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.DateField._created_at

fiftyone.core.fields.DateField.html#_created_at

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.DateField.to_mongo

fiftyone.core.fields.DateField.html#to_mongo

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.DateField.to_python

fiftyone.core.fields.DateField.html#to_python

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.DateField.validate

fiftyone.core.fields.DateField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.DateTimeField

fiftyone.core.fields.DateTimeField.html

Class

Class

PUBLIC

A datetime field.
fiftyone.core.fields.DateTimeField.__init__

fiftyone.core.fields.DateTimeField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.DateTimeField._description

fiftyone.core.fields.DateTimeField.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.DateTimeField._info

fiftyone.core.fields.DateTimeField.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.DateTimeField._read_only

fiftyone.core.fields.DateTimeField.html#_read_only

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.DateTimeField._created_at

fiftyone.core.fields.DateTimeField.html#_created_at

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.DateTimeField.validate

fiftyone.core.fields.DateTimeField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.FloatField

fiftyone.core.fields.FloatField.html

Class

Class

PUBLIC

A floating point number field.
fiftyone.core.fields.FloatField.__init__

fiftyone.core.fields.FloatField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.FloatField._description

fiftyone.core.fields.FloatField.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.FloatField._info

fiftyone.core.fields.FloatField.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.FloatField._read_only

fiftyone.core.fields.FloatField.html#_read_only

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.FloatField._created_at

fiftyone.core.fields.FloatField.html#_created_at

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.FloatField.to_mongo

fiftyone.core.fields.FloatField.html#to_mongo

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.FloatField.validate

fiftyone.core.fields.FloatField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.StringField

fiftyone.core.fields.StringField.html

Class

Class

PUBLIC

A unicode string field.
fiftyone.core.fields.StringField.__init__

fiftyone.core.fields.StringField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.StringField._description

fiftyone.core.fields.StringField.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.StringField._info

fiftyone.core.fields.StringField.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.StringField._read_only

fiftyone.core.fields.StringField.html#_read_only

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.StringField._created_at

fiftyone.core.fields.StringField.html#_created_at

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.ColorField

fiftyone.core.fields.ColorField.html

Class

Class

PUBLIC

A string field that holds a hex color string like '#FF6D04'.
fiftyone.core.fields.ColorField.validate

fiftyone.core.fields.ColorField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.ListField

fiftyone.core.fields.ListField.html

Class

Class

PUBLIC

A list field that wraps a standard Field, allowing multiple instances of the field to be stored as a list in the database.
fiftyone.core.fields.ListField.__init__

fiftyone.core.fields.ListField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.ListField._description

fiftyone.core.fields.ListField.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.ListField._info

fiftyone.core.fields.ListField.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.ListField._read_only

fiftyone.core.fields.ListField.html#_read_only

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.ListField._created_at

fiftyone.core.fields.ListField.html#_created_at

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.ListField.__str__

fiftyone.core.fields.ListField.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.ListField._set_dataset

fiftyone.core.fields.ListField.html#_set_dataset

Function

Method

PRIVATE

Undocumented
fiftyone.core.fields.HeatmapRangeField

fiftyone.core.fields.HeatmapRangeField.html

Class

Class

PUBLIC

A [min, max] range of the values in a fiftyone.core.labels.Heatmap.
fiftyone.core.fields.HeatmapRangeField.__init__

fiftyone.core.fields.HeatmapRangeField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.HeatmapRangeField.__str__

fiftyone.core.fields.HeatmapRangeField.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.HeatmapRangeField.validate

fiftyone.core.fields.HeatmapRangeField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.DictField

fiftyone.core.fields.DictField.html

Class

Class

PUBLIC

A dictionary field that wraps a standard Python dictionary.
fiftyone.core.fields.DictField.__init__

fiftyone.core.fields.DictField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.DictField._description

fiftyone.core.fields.DictField.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.DictField._info

fiftyone.core.fields.DictField.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.DictField._read_only

fiftyone.core.fields.DictField.html#_read_only

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.DictField._created_at

fiftyone.core.fields.DictField.html#_created_at

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.DictField.__str__

fiftyone.core.fields.DictField.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.DictField._set_dataset

fiftyone.core.fields.DictField.html#_set_dataset

Function

Method

PRIVATE

Undocumented
fiftyone.core.fields.DictField.validate

fiftyone.core.fields.DictField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.KeypointsField

fiftyone.core.fields.KeypointsField.html

Class

Class

PUBLIC

A list of (x, y) coordinate pairs.
fiftyone.core.fields.KeypointsField.__str__

fiftyone.core.fields.KeypointsField.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.KeypointsField.validate

fiftyone.core.fields.KeypointsField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.PolylinePointsField

fiftyone.core.fields.PolylinePointsField.html

Class

Class

PUBLIC

A list of lists of (x, y) coordinate pairs.
fiftyone.core.fields.PolylinePointsField.__str__

fiftyone.core.fields.PolylinePointsField.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.PolylinePointsField.validate

fiftyone.core.fields.PolylinePointsField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields._GeoField

fiftyone.core.fields._GeoField.html

Class

Class

PRIVATE

Base class for GeoJSON fields.
fiftyone.core.fields._GeoField._TYPE

fiftyone.core.fields._GeoField.html#_TYPE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.fields._GeoField.to_mongo

fiftyone.core.fields._GeoField.html#to_mongo

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields._GeoField.to_python

fiftyone.core.fields._GeoField.html#to_python

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.GeoPointField

fiftyone.core.fields.GeoPointField.html

Class

Class

PUBLIC

A GeoJSON field storing a longitude and latitude coordinate point.
fiftyone.core.fields.GeoPointField._TYPE

fiftyone.core.fields.GeoPointField.html#_TYPE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.fields.GeoPointField.validate

fiftyone.core.fields.GeoPointField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.GeoLineStringField

fiftyone.core.fields.GeoLineStringField.html

Class

Class

PUBLIC

A GeoJSON field storing a line of longitude and latitude coordinates.
fiftyone.core.fields.GeoLineStringField._TYPE

fiftyone.core.fields.GeoLineStringField.html#_TYPE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.fields.GeoLineStringField.validate

fiftyone.core.fields.GeoLineStringField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.GeoPolygonField

fiftyone.core.fields.GeoPolygonField.html

Class

Class

PUBLIC

A GeoJSON field storing a polygon of longitude and latitude coordinates.
fiftyone.core.fields.GeoPolygonField._TYPE

fiftyone.core.fields.GeoPolygonField.html#_TYPE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.fields.GeoPolygonField.validate

fiftyone.core.fields.GeoPolygonField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.GeoMultiPointField

fiftyone.core.fields.GeoMultiPointField.html

Class

Class

PUBLIC

A GeoJSON field storing a list of points.
fiftyone.core.fields.GeoMultiPointField._TYPE

fiftyone.core.fields.GeoMultiPointField.html#_TYPE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.fields.GeoMultiPointField.validate

fiftyone.core.fields.GeoMultiPointField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.GeoMultiLineStringField

fiftyone.core.fields.GeoMultiLineStringField.html

Class

Class

PUBLIC

A GeoJSON field storing a list of lines.
fiftyone.core.fields.GeoMultiLineStringField._TYPE

fiftyone.core.fields.GeoMultiLineStringField.html#_TYPE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.fields.GeoMultiLineStringField.validate

fiftyone.core.fields.GeoMultiLineStringField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.GeoMultiPolygonField

fiftyone.core.fields.GeoMultiPolygonField.html

Class

Class

PUBLIC

A GeoJSON field storing a list of polygons.
fiftyone.core.fields.GeoMultiPolygonField._TYPE

fiftyone.core.fields.GeoMultiPolygonField.html#_TYPE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.fields.GeoMultiPolygonField.validate

fiftyone.core.fields.GeoMultiPolygonField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.VectorField

fiftyone.core.fields.VectorField.html

Class

Class

PUBLIC

A one-dimensional array field.
fiftyone.core.fields.VectorField.__init__

fiftyone.core.fields.VectorField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.VectorField._description

fiftyone.core.fields.VectorField.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.VectorField._info

fiftyone.core.fields.VectorField.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.VectorField._read_only

fiftyone.core.fields.VectorField.html#_read_only

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.VectorField._created_at

fiftyone.core.fields.VectorField.html#_created_at

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.VectorField.to_mongo

fiftyone.core.fields.VectorField.html#to_mongo

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.VectorField.to_python

fiftyone.core.fields.VectorField.html#to_python

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.VectorField.validate

fiftyone.core.fields.VectorField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.ArrayField

fiftyone.core.fields.ArrayField.html

Class

Class

PUBLIC

An n-dimensional array field.
fiftyone.core.fields.ArrayField.__init__

fiftyone.core.fields.ArrayField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.ArrayField._description

fiftyone.core.fields.ArrayField.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.ArrayField._info

fiftyone.core.fields.ArrayField.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.ArrayField._read_only

fiftyone.core.fields.ArrayField.html#_read_only

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.ArrayField._created_at

fiftyone.core.fields.ArrayField.html#_created_at

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.ArrayField.to_mongo

fiftyone.core.fields.ArrayField.html#to_mongo

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.ArrayField.to_python

fiftyone.core.fields.ArrayField.html#to_python

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.ArrayField.validate

fiftyone.core.fields.ArrayField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.FrameNumberField

fiftyone.core.fields.FrameNumberField.html

Class

Class

PUBLIC

A video frame number field.
fiftyone.core.fields.FrameNumberField.validate

fiftyone.core.fields.FrameNumberField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.FrameSupportField

fiftyone.core.fields.FrameSupportField.html

Class

Class

PUBLIC

A [first, last] frame support in a video.
fiftyone.core.fields.FrameSupportField.__init__

fiftyone.core.fields.FrameSupportField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.FrameSupportField.__str__

fiftyone.core.fields.FrameSupportField.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.FrameSupportField.validate

fiftyone.core.fields.FrameSupportField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.ClassesField

fiftyone.core.fields.ClassesField.html

Class

Class

PUBLIC

A ListField that stores class label strings.
fiftyone.core.fields.ClassesField.__init__

fiftyone.core.fields.ClassesField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.ClassesField.__str__

fiftyone.core.fields.ClassesField.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.MaskTargetsField

fiftyone.core.fields.MaskTargetsField.html

Class

Class

PUBLIC

A DictField that stores mapping between integer keys or RGB string hex keys and string targets.
fiftyone.core.fields.MaskTargetsField.__init__

fiftyone.core.fields.MaskTargetsField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.MaskTargetsField.to_mongo

fiftyone.core.fields.MaskTargetsField.html#to_mongo

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.MaskTargetsField.to_python

fiftyone.core.fields.MaskTargetsField.html#to_python

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.MaskTargetsField.validate

fiftyone.core.fields.MaskTargetsField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.is_integer_mask_targets

fiftyone.core.fields.html#is_integer_mask_targets

Function

Function

PUBLIC

Determines whether the provided mask targets use integer keys.
fiftyone.core.fields.is_integer_target

fiftyone.core.fields.html#is_integer_target

Function

Function

PUBLIC

Determines whether the provided target is an integer.
fiftyone.core.fields.is_rgb_mask_targets

fiftyone.core.fields.html#is_rgb_mask_targets

Function

Function

PUBLIC

Determines whether the provided mask targets use RGB hex string keys.
fiftyone.core.fields.is_rgb_target

fiftyone.core.fields.html#is_rgb_target

Function

Function

PUBLIC

Determines whether the provided target is an RGB string.
fiftyone.core.fields.hex_to_int

fiftyone.core.fields.html#hex_to_int

Function

Function

PUBLIC

Converts a hex string like "#ff6d04" to a hex integer.
fiftyone.core.fields.int_to_hex

fiftyone.core.fields.html#int_to_hex

Function

Function

PUBLIC

Converts an RRGGBB integer value to hex string like "#ff6d04".
fiftyone.core.fields.rgb_array_to_int

fiftyone.core.fields.html#rgb_array_to_int

Function

Function

PUBLIC

Converts an RGB mask array to a 2D hex integer mask array.
fiftyone.core.fields.int_array_to_rgb

fiftyone.core.fields.html#int_array_to_rgb

Function

Function

PUBLIC

Converts a 2D hex integer mask array to an RGB mask array.
fiftyone.core.fields.EmbeddedDocumentField

fiftyone.core.fields.EmbeddedDocumentField.html

Class

Class

PUBLIC

A field that stores instances of a given type of fiftyone.core.odm.BaseEmbeddedDocument object.
fiftyone.core.fields.EmbeddedDocumentField.__init__

fiftyone.core.fields.EmbeddedDocumentField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.EmbeddedDocumentField.fields

fiftyone.core.fields.EmbeddedDocumentField.html#fields

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._description

fiftyone.core.fields.EmbeddedDocumentField.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._info

fiftyone.core.fields.EmbeddedDocumentField.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._read_only

fiftyone.core.fields.EmbeddedDocumentField.html#_read_only

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._created_at

fiftyone.core.fields.EmbeddedDocumentField.html#_created_at

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._selected_fields

fiftyone.core.fields.EmbeddedDocumentField.html#_selected_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._excluded_fields

fiftyone.core.fields.EmbeddedDocumentField.html#_excluded_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField.__fields

fiftyone.core.fields.EmbeddedDocumentField.html#__fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField.__str__

fiftyone.core.fields.EmbeddedDocumentField.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._set_created_at

fiftyone.core.fields.EmbeddedDocumentField.html#_set_created_at

Function

Method

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._set_dataset

fiftyone.core.fields.EmbeddedDocumentField.html#_set_dataset

Function

Method

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._fields

fiftyone.core.fields.EmbeddedDocumentField.html#_fields

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._use_view

fiftyone.core.fields.EmbeddedDocumentField.html#_use_view

Function

Method

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._get_field_names

fiftyone.core.fields.EmbeddedDocumentField.html#_get_field_names

Function

Method

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._get_default_fields

fiftyone.core.fields.EmbeddedDocumentField.html#_get_default_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._to_db_fields

fiftyone.core.fields.EmbeddedDocumentField.html#_to_db_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField.has_field

fiftyone.core.fields.EmbeddedDocumentField.html#has_field

Function

Method

PUBLIC

Determines whether this field has the given embedded field.
fiftyone.core.fields.EmbeddedDocumentField.get_field

fiftyone.core.fields.EmbeddedDocumentField.html#get_field

Function

Method

PUBLIC

Returns the field for the provided path, or None.
fiftyone.core.fields.EmbeddedDocumentField.get_field_schema

fiftyone.core.fields.EmbeddedDocumentField.html#get_field_schema

Function

Method

PUBLIC

Returns a schema dictionary describing the fields of the embedded document field.
fiftyone.core.fields.EmbeddedDocumentField.validate

fiftyone.core.fields.EmbeddedDocumentField.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._merge_fields

fiftyone.core.fields.EmbeddedDocumentField.html#_merge_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._declare_field

fiftyone.core.fields.EmbeddedDocumentField.html#_declare_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._update_field

fiftyone.core.fields.EmbeddedDocumentField.html#_update_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentField._undeclare_field

fiftyone.core.fields.EmbeddedDocumentField.html#_undeclare_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentListField

fiftyone.core.fields.EmbeddedDocumentListField.html

Class

Class

PUBLIC

A field that stores a list of a given type of fiftyone.core.odm.BaseEmbeddedDocument objects.
fiftyone.core.fields.EmbeddedDocumentListField.__init__

fiftyone.core.fields.EmbeddedDocumentListField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.EmbeddedDocumentListField._description

fiftyone.core.fields.EmbeddedDocumentListField.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentListField._info

fiftyone.core.fields.EmbeddedDocumentListField.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentListField._read_only

fiftyone.core.fields.EmbeddedDocumentListField.html#_read_only

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentListField._created_at

fiftyone.core.fields.EmbeddedDocumentListField.html#_created_at

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.fields.EmbeddedDocumentListField.__str__

fiftyone.core.fields.EmbeddedDocumentListField.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.fields.ReferenceField

fiftyone.core.fields.ReferenceField.html

Class

Class

PUBLIC

A reference field.
fiftyone.core.fields._ARRAY_FIELDS

fiftyone.core.fields.html#_ARRAY_FIELDS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.fields._PRIMITIVE_FIELDS

fiftyone.core.fields.html#_PRIMITIVE_FIELDS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.odm.embedded_document.BaseEmbeddedDocument

fiftyone.core.odm.embedded_document.BaseEmbeddedDocument.html

Class

Class

PUBLIC

Base class for documents that are embedded within other documents and therefore are not stored in their own collection in the database.
fiftyone.core.odm.embedded_document.EmbeddedDocument

fiftyone.core.odm.embedded_document.EmbeddedDocument.html

Class

Class

PUBLIC

Base class for documents that are embedded within other documents and therefore are not stored in their own collection in the database.
fiftyone.core.odm.embedded_document.EmbeddedDocument.meta

fiftyone.core.odm.embedded_document.EmbeddedDocument.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.embedded_document.EmbeddedDocument.__init__

fiftyone.core.odm.embedded_document.EmbeddedDocument.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.embedded_document.DynamicEmbeddedDocumentException

fiftyone.core.odm.embedded_document.DynamicEmbeddedDocumentException.html

Class

Exception

PUBLIC

Exception raised when an error occurs in a dynamic document operation.
fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument

fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument.html

Class

Class

PUBLIC

Base class for dynamic documents that are embedded within other documents and therefore aren't stored in their own collection in the database.
fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument.meta

fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument.__init__

fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument.__setattr__

fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument.html#__setattr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument.__hash__

fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument.html#__hash__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument._raise_reserved_attribute_exception

fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument.html#_raise_reserved_attribute_exception

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument._extract_attribute_from_exception

fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument.html#_extract_attribute_from_exception

Function

Static Method

PRIVATE

Undocumented
fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument._get_field

fiftyone.core.odm.embedded_document.DynamicEmbeddedDocument.html#_get_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.runs.RunDocument

fiftyone.core.odm.runs.RunDocument.html

Class

Class

PUBLIC

Backing document for dataset runs.
fiftyone.core.odm.runs.RunDocument.meta

fiftyone.core.odm.runs.RunDocument.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.runs.RunDocument.dataset_id

fiftyone.core.odm.runs.RunDocument.html#dataset_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.runs.RunDocument.key

fiftyone.core.odm.runs.RunDocument.html#key

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.runs.RunDocument.version

fiftyone.core.odm.runs.RunDocument.html#version

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.runs.RunDocument.timestamp

fiftyone.core.odm.runs.RunDocument.html#timestamp

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.runs.RunDocument.config

fiftyone.core.odm.runs.RunDocument.html#config

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.runs.RunDocument.view_stages

fiftyone.core.odm.runs.RunDocument.html#view_stages

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.runs.RunDocument.results

fiftyone.core.odm.runs.RunDocument.html#results

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.views.SavedViewDocument

fiftyone.core.odm.views.SavedViewDocument.html

Class

Class

PUBLIC

Backing document for saved views.
fiftyone.core.odm.views.SavedViewDocument.meta

fiftyone.core.odm.views.SavedViewDocument.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.views.SavedViewDocument._EDITABLE_FIELDS

fiftyone.core.odm.views.SavedViewDocument.html#_EDITABLE_FIELDS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.odm.views.SavedViewDocument.dataset_id

fiftyone.core.odm.views.SavedViewDocument.html#dataset_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.views.SavedViewDocument.name

fiftyone.core.odm.views.SavedViewDocument.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.views.SavedViewDocument.description

fiftyone.core.odm.views.SavedViewDocument.html#description

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.views.SavedViewDocument.slug

fiftyone.core.odm.views.SavedViewDocument.html#slug

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.views.SavedViewDocument.color

fiftyone.core.odm.views.SavedViewDocument.html#color

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.views.SavedViewDocument.view_stages

fiftyone.core.odm.views.SavedViewDocument.html#view_stages

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.views.SavedViewDocument.created_at

fiftyone.core.odm.views.SavedViewDocument.html#created_at

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.views.SavedViewDocument.last_modified_at

fiftyone.core.odm.views.SavedViewDocument.html#last_modified_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.views.SavedViewDocument.last_loaded_at

fiftyone.core.odm.views.SavedViewDocument.html#last_loaded_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace._validate_children

fiftyone.core.odm.workspace.html#_validate_children

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.workspace.AppComponent

fiftyone.core.odm.workspace.AppComponent.html

Class

Class

PUBLIC

Base class for App components.
fiftyone.core.odm.workspace.AppComponent.component_id

fiftyone.core.odm.workspace.AppComponent.html#component_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.Panel

fiftyone.core.odm.workspace.Panel.html

Class

Class

PUBLIC

Document for a panel (tab) within a Workspace in the App.
fiftyone.core.odm.workspace.Panel.meta

fiftyone.core.odm.workspace.Panel.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.Panel.type

fiftyone.core.odm.workspace.Panel.html#type

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.Panel.pinned

fiftyone.core.odm.workspace.Panel.html#pinned

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.Panel.state

fiftyone.core.odm.workspace.Panel.html#state

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.Space

fiftyone.core.odm.workspace.Space.html

Class

Class

PUBLIC

Document for configuration of a Space in the App.
fiftyone.core.odm.workspace.Space.orientation

fiftyone.core.odm.workspace.Space.html#orientation

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.Space.meta

fiftyone.core.odm.workspace.Space.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.Space.children

fiftyone.core.odm.workspace.Space.html#children

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.Space.active_child

fiftyone.core.odm.workspace.Space.html#active_child

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.Space.sizes

fiftyone.core.odm.workspace.Space.html#sizes

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.Space._name

fiftyone.core.odm.workspace.Space.html#_name

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.odm.workspace.Space.name

fiftyone.core.odm.workspace.Space.html#name

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.odm.workspace.WorkspaceDocument

fiftyone.core.odm.workspace.WorkspaceDocument.html

Class

Class

PUBLIC

Document for configuration of a saved workspace in the App.
fiftyone.core.odm.workspace.WorkspaceDocument.meta

fiftyone.core.odm.workspace.WorkspaceDocument.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.WorkspaceDocument._EDITABLE_FIELDS

fiftyone.core.odm.workspace.WorkspaceDocument.html#_EDITABLE_FIELDS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.odm.workspace.WorkspaceDocument.__init__

fiftyone.core.odm.workspace.WorkspaceDocument.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.workspace.WorkspaceDocument.child

fiftyone.core.odm.workspace.WorkspaceDocument.html#child

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.WorkspaceDocument.color

fiftyone.core.odm.workspace.WorkspaceDocument.html#color

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.WorkspaceDocument.created_at

fiftyone.core.odm.workspace.WorkspaceDocument.html#created_at

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.WorkspaceDocument.dataset_id

fiftyone.core.odm.workspace.WorkspaceDocument.html#dataset_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.WorkspaceDocument.description

fiftyone.core.odm.workspace.WorkspaceDocument.html#description

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.WorkspaceDocument.last_loaded_at

fiftyone.core.odm.workspace.WorkspaceDocument.html#last_loaded_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.WorkspaceDocument.last_modified_at

fiftyone.core.odm.workspace.WorkspaceDocument.html#last_modified_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.WorkspaceDocument._name

fiftyone.core.odm.workspace.WorkspaceDocument.html#_name

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.odm.workspace.WorkspaceDocument.slug

fiftyone.core.odm.workspace.WorkspaceDocument.html#slug

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.WorkspaceDocument.name 0

fiftyone.core.odm.workspace.WorkspaceDocument.html#name%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.workspace.WorkspaceDocument.name

fiftyone.core.odm.workspace.WorkspaceDocument.html#name

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.odm.workspace.WorkspaceDocument.name.setter

fiftyone.core.odm.workspace.WorkspaceDocument.html#name.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.workspace.default_workspace_factory

fiftyone.core.odm.workspace.html#default_workspace_factory

Function

Function

PUBLIC

Creates a default top-level instance of Space
fiftyone.core.odm.dataset.fol

fiftyone.core.odm.dataset.html#fol

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.fom

fiftyone.core.odm.dataset.html#fom

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.fop

fiftyone.core.odm.dataset.html#fop

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.logger

fiftyone.core.odm.dataset.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.SampleFieldDocument

fiftyone.core.odm.dataset.SampleFieldDocument.html

Class

Class

PUBLIC

Description of a sample field.
fiftyone.core.odm.dataset.SampleFieldDocument.meta

fiftyone.core.odm.dataset.SampleFieldDocument.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.SampleFieldDocument.name

fiftyone.core.odm.dataset.SampleFieldDocument.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.SampleFieldDocument.ftype

fiftyone.core.odm.dataset.SampleFieldDocument.html#ftype

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.SampleFieldDocument.embedded_doc_type

fiftyone.core.odm.dataset.SampleFieldDocument.html#embedded_doc_type

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.SampleFieldDocument.subfield

fiftyone.core.odm.dataset.SampleFieldDocument.html#subfield

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.SampleFieldDocument.fields

fiftyone.core.odm.dataset.SampleFieldDocument.html#fields

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.SampleFieldDocument.db_field

fiftyone.core.odm.dataset.SampleFieldDocument.html#db_field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.SampleFieldDocument.description

fiftyone.core.odm.dataset.SampleFieldDocument.html#description

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.SampleFieldDocument.info

fiftyone.core.odm.dataset.SampleFieldDocument.html#info

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.SampleFieldDocument.read_only

fiftyone.core.odm.dataset.SampleFieldDocument.html#read_only

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.SampleFieldDocument.created_at

fiftyone.core.odm.dataset.SampleFieldDocument.html#created_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.SampleFieldDocument._set_created_at

fiftyone.core.odm.dataset.SampleFieldDocument.html#_set_created_at

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.SampleFieldDocument.to_field

fiftyone.core.odm.dataset.SampleFieldDocument.html#to_field

Function

Method

PUBLIC

Creates the fiftyone.core.fields.Field specified by this document.
fiftyone.core.odm.dataset.SampleFieldDocument.from_field

fiftyone.core.odm.dataset.SampleFieldDocument.html#from_field

Function

Class Method

PUBLIC

Creates a SampleFieldDocument for a field.
fiftyone.core.odm.dataset.SampleFieldDocument._get_attr_repr

fiftyone.core.odm.dataset.SampleFieldDocument.html#_get_attr_repr

Function

Static Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.SampleFieldDocument._get_field_documents

fiftyone.core.odm.dataset.SampleFieldDocument.html#_get_field_documents

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.SidebarGroupDocument

fiftyone.core.odm.dataset.SidebarGroupDocument.html

Class

Class

PUBLIC

Description of a sidebar group in the App.
fiftyone.core.odm.dataset.SidebarGroupDocument.paths

fiftyone.core.odm.dataset.SidebarGroupDocument.html#paths

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.SidebarGroupDocument.expanded

fiftyone.core.odm.dataset.SidebarGroupDocument.html#expanded

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.SidebarGroupDocument.meta

fiftyone.core.odm.dataset.SidebarGroupDocument.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.SidebarGroupDocument.name

fiftyone.core.odm.dataset.SidebarGroupDocument.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.ColorScheme

fiftyone.core.odm.dataset.ColorScheme.html

Class

Class

PUBLIC

Description of a color scheme in the App.
fiftyone.core.odm.dataset.ColorScheme.color_by

fiftyone.core.odm.dataset.ColorScheme.html#color_by

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.ColorScheme.color_pool

fiftyone.core.odm.dataset.ColorScheme.html#color_pool

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.ColorScheme.multicolor_keypoints

fiftyone.core.odm.dataset.ColorScheme.html#multicolor_keypoints

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.ColorScheme.opacity

fiftyone.core.odm.dataset.ColorScheme.html#opacity

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.ColorScheme.show_skeletons

fiftyone.core.odm.dataset.ColorScheme.html#show_skeletons

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.ColorScheme.fields

fiftyone.core.odm.dataset.ColorScheme.html#fields

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.ColorScheme.default_mask_targets_colors

fiftyone.core.odm.dataset.ColorScheme.html#default_mask_targets_colors

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.ColorScheme.default_colorscale

fiftyone.core.odm.dataset.ColorScheme.html#default_colorscale

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.ColorScheme.colorscales

fiftyone.core.odm.dataset.ColorScheme.html#colorscales

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.ColorScheme.label_tags

fiftyone.core.odm.dataset.ColorScheme.html#label_tags

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.ColorScheme.meta

fiftyone.core.odm.dataset.ColorScheme.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.ColorScheme.id

fiftyone.core.odm.dataset.ColorScheme.html#id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.ColorScheme._id

fiftyone.core.odm.dataset.ColorScheme.html#_id

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.odm.dataset.ColorScheme._id.setter

fiftyone.core.odm.dataset.ColorScheme.html#_id.setter

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.ColorScheme._validate

fiftyone.core.odm.dataset.ColorScheme.html#_validate

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.ColorScheme._validate_color_by

fiftyone.core.odm.dataset.ColorScheme.html#_validate_color_by

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.ColorScheme._validate_opacity

fiftyone.core.odm.dataset.ColorScheme.html#_validate_opacity

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.ColorScheme._validate_default_mask_targets_colors

fiftyone.core.odm.dataset.ColorScheme.html#_validate_default_mask_targets_colors

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.ColorScheme._validate_fields

fiftyone.core.odm.dataset.ColorScheme.html#_validate_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.ColorScheme._validate_mask_targets

fiftyone.core.odm.dataset.ColorScheme.html#_validate_mask_targets

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.ColorScheme._validate_colorscales

fiftyone.core.odm.dataset.ColorScheme.html#_validate_colorscales

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.ColorScheme._validate_default_colorscale

fiftyone.core.odm.dataset.ColorScheme.html#_validate_default_colorscale

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.ColorScheme._validate_single_colorscale

fiftyone.core.odm.dataset.ColorScheme.html#_validate_single_colorscale

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.KeypointSkeleton

fiftyone.core.odm.dataset.KeypointSkeleton.html

Class

Class

PUBLIC

Description of a keypoint skeleton.
fiftyone.core.odm.dataset.KeypointSkeleton.labels

fiftyone.core.odm.dataset.KeypointSkeleton.html#labels

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.KeypointSkeleton.meta

fiftyone.core.odm.dataset.KeypointSkeleton.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.KeypointSkeleton.edges

fiftyone.core.odm.dataset.KeypointSkeleton.html#edges

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetAppConfig

fiftyone.core.odm.dataset.DatasetAppConfig.html

Class

Class

PUBLIC

Dataset-specific settings that customize how a dataset is visualized in the App.
fiftyone.core.odm.dataset.DatasetAppConfig.color_scheme

fiftyone.core.odm.dataset.DatasetAppConfig.html#color_scheme

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetAppConfig.disable_frame_filtering

fiftyone.core.odm.dataset.DatasetAppConfig.html#disable_frame_filtering

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetAppConfig.grid_media_field

fiftyone.core.odm.dataset.DatasetAppConfig.html#grid_media_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetAppConfig.media_fields

fiftyone.core.odm.dataset.DatasetAppConfig.html#media_fields

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetAppConfig.modal_media_field

fiftyone.core.odm.dataset.DatasetAppConfig.html#modal_media_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetAppConfig.dynamic_groups_target_frame_rate

fiftyone.core.odm.dataset.DatasetAppConfig.html#dynamic_groups_target_frame_rate

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetAppConfig.plugins

fiftyone.core.odm.dataset.DatasetAppConfig.html#plugins

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetAppConfig.sidebar_groups

fiftyone.core.odm.dataset.DatasetAppConfig.html#sidebar_groups

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetAppConfig.meta

fiftyone.core.odm.dataset.DatasetAppConfig.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetAppConfig.media_fallback

fiftyone.core.odm.dataset.DatasetAppConfig.html#media_fallback

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetAppConfig.default_sidebar_groups

fiftyone.core.odm.dataset.DatasetAppConfig.html#default_sidebar_groups

Function

Static Method

PUBLIC

Generates the default sidebar_groups for the given collection.
fiftyone.core.odm.dataset.DatasetAppConfig.is_custom

fiftyone.core.odm.dataset.DatasetAppConfig.html#is_custom

Function

Method

PUBLIC

Determines whether this app config differs from the default one.
fiftyone.core.odm.dataset.DatasetAppConfig._delete_path

fiftyone.core.odm.dataset.DatasetAppConfig.html#_delete_path

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.DatasetAppConfig._delete_paths

fiftyone.core.odm.dataset.DatasetAppConfig.html#_delete_paths

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.DatasetAppConfig._rename_path

fiftyone.core.odm.dataset.DatasetAppConfig.html#_rename_path

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.DatasetAppConfig._rename_paths

fiftyone.core.odm.dataset.DatasetAppConfig.html#_rename_paths

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset.DatasetAppConfig._add_path_to_sidebar_group

fiftyone.core.odm.dataset.DatasetAppConfig.html#_add_path_to_sidebar_group

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.dataset._make_default_sidebar_groups

fiftyone.core.odm.dataset.html#_make_default_sidebar_groups

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.dataset._parse_schema

fiftyone.core.odm.dataset.html#_parse_schema

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.dataset._delete_path

fiftyone.core.odm.dataset.html#_delete_path

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.dataset._rename_path

fiftyone.core.odm.dataset.html#_rename_path

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.dataset._matches_path

fiftyone.core.odm.dataset.html#_matches_path

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.dataset._update_path

fiftyone.core.odm.dataset.html#_update_path

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.dataset.DatasetDocument

fiftyone.core.odm.dataset.DatasetDocument.html

Class

Class

PUBLIC

Backing document for datasets.
fiftyone.core.odm.dataset.DatasetDocument.meta

fiftyone.core.odm.dataset.DatasetDocument.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.name

fiftyone.core.odm.dataset.DatasetDocument.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.slug

fiftyone.core.odm.dataset.DatasetDocument.html#slug

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.version

fiftyone.core.odm.dataset.DatasetDocument.html#version

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.created_at

fiftyone.core.odm.dataset.DatasetDocument.html#created_at

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.last_modified_at

fiftyone.core.odm.dataset.DatasetDocument.html#last_modified_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.last_loaded_at

fiftyone.core.odm.dataset.DatasetDocument.html#last_loaded_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.sample_collection_name

fiftyone.core.odm.dataset.DatasetDocument.html#sample_collection_name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.frame_collection_name

fiftyone.core.odm.dataset.DatasetDocument.html#frame_collection_name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.persistent

fiftyone.core.odm.dataset.DatasetDocument.html#persistent

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.media_type

fiftyone.core.odm.dataset.DatasetDocument.html#media_type

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.group_field

fiftyone.core.odm.dataset.DatasetDocument.html#group_field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.group_media_types

fiftyone.core.odm.dataset.DatasetDocument.html#group_media_types

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.default_group_slice

fiftyone.core.odm.dataset.DatasetDocument.html#default_group_slice

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.tags

fiftyone.core.odm.dataset.DatasetDocument.html#tags

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.description

fiftyone.core.odm.dataset.DatasetDocument.html#description

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.info

fiftyone.core.odm.dataset.DatasetDocument.html#info

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.app_config

fiftyone.core.odm.dataset.DatasetDocument.html#app_config

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.classes

fiftyone.core.odm.dataset.DatasetDocument.html#classes

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.default_classes

fiftyone.core.odm.dataset.DatasetDocument.html#default_classes

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.mask_targets

fiftyone.core.odm.dataset.DatasetDocument.html#mask_targets

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.default_mask_targets

fiftyone.core.odm.dataset.DatasetDocument.html#default_mask_targets

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.skeletons

fiftyone.core.odm.dataset.DatasetDocument.html#skeletons

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.default_skeleton

fiftyone.core.odm.dataset.DatasetDocument.html#default_skeleton

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.sample_fields

fiftyone.core.odm.dataset.DatasetDocument.html#sample_fields

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.frame_fields

fiftyone.core.odm.dataset.DatasetDocument.html#frame_fields

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.saved_views

fiftyone.core.odm.dataset.DatasetDocument.html#saved_views

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.workspaces

fiftyone.core.odm.dataset.DatasetDocument.html#workspaces

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.annotation_runs

fiftyone.core.odm.dataset.DatasetDocument.html#annotation_runs

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.brain_methods

fiftyone.core.odm.dataset.DatasetDocument.html#brain_methods

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.evaluations

fiftyone.core.odm.dataset.DatasetDocument.html#evaluations

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.runs

fiftyone.core.odm.dataset.DatasetDocument.html#runs

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.get_saved_views

fiftyone.core.odm.dataset.DatasetDocument.html#get_saved_views

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.get_workspaces

fiftyone.core.odm.dataset.DatasetDocument.html#get_workspaces

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.get_annotation_runs

fiftyone.core.odm.dataset.DatasetDocument.html#get_annotation_runs

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.get_brain_methods

fiftyone.core.odm.dataset.DatasetDocument.html#get_brain_methods

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.get_evaluations

fiftyone.core.odm.dataset.DatasetDocument.html#get_evaluations

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.get_runs

fiftyone.core.odm.dataset.DatasetDocument.html#get_runs

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.dataset.DatasetDocument.to_dict

fiftyone.core.odm.dataset.DatasetDocument.html#to_dict

Function

Method

PUBLIC

Serializes this document to a BSON/JSON dictionary.
fiftyone.core.singletons.DatasetSingleton

fiftyone.core.singletons.DatasetSingleton.html

Class

Class

PUBLIC

Singleton metaclass for fiftyone.core.dataset.Dataset.
fiftyone.core.singletons.DatasetSingleton.__new__

fiftyone.core.singletons.DatasetSingleton.html#__new__

Function

Method

PUBLIC

Undocumented
fiftyone.core.singletons.DatasetSingleton.__call__

fiftyone.core.singletons.DatasetSingleton.html#__call__

Function

Method

PUBLIC

Undocumented
fiftyone.core.singletons.DocumentSingleton

fiftyone.core.singletons.DocumentSingleton.html

Class

Class

PUBLIC

Singleton metaclass interface for fiftyone.core.document.Document subclasses.
fiftyone.core.singletons.DocumentSingleton._register_instance

fiftyone.core.singletons.DocumentSingleton.html#_register_instance

Function

Method

PRIVATE

Registers the given instance in the weakref dictionary.
fiftyone.core.singletons.DocumentSingleton._get_instance

fiftyone.core.singletons.DocumentSingleton.html#_get_instance

Function

Method

PRIVATE

Retrieves the fiftyone.core.document.Document instance for the given document, if one exists.
fiftyone.core.singletons.DocumentSingleton._reload_instance

fiftyone.core.singletons.DocumentSingleton.html#_reload_instance

Function

Method

PRIVATE

Reloads the backing document for the given instance (or view), if a reference exists to it.
fiftyone.core.singletons.SampleSingleton

fiftyone.core.singletons.SampleSingleton.html

Class

Class

PUBLIC

Singleton metaclass for fiftyone.core.sample.Sample.
fiftyone.core.singletons.SampleSingleton.__new__

fiftyone.core.singletons.SampleSingleton.html#__new__

Function

Method

PUBLIC

Undocumented
fiftyone.core.singletons.SampleSingleton._register_instance

fiftyone.core.singletons.SampleSingleton.html#_register_instance

Function

Method

PRIVATE

Registers the given instance in the weakref dictionary.
fiftyone.core.singletons.SampleSingleton._get_instance

fiftyone.core.singletons.SampleSingleton.html#_get_instance

Function

Method

PRIVATE

Retrieves the fiftyone.core.document.Document instance for the given document, if one exists.
fiftyone.core.singletons.SampleSingleton._reload_instance

fiftyone.core.singletons.SampleSingleton.html#_reload_instance

Function

Method

PRIVATE

Reloads the backing document for the given instance (or view), if a reference exists to it.
fiftyone.core.singletons.SampleSingleton._rename_fields

fiftyone.core.singletons.SampleSingleton.html#_rename_fields

Function

Method

PRIVATE

Renames the field on all in-memory samples in the collection.
fiftyone.core.singletons.SampleSingleton._clear_fields

fiftyone.core.singletons.SampleSingleton.html#_clear_fields

Function

Method

PRIVATE

Clears the values for the given fields (i.e., sets them to None) on all in-memory samples in the collection.
fiftyone.core.singletons.SampleSingleton._purge_fields

fiftyone.core.singletons.SampleSingleton.html#_purge_fields

Function

Method

PRIVATE

Removes the fields from all in-memory samples in the collection.
fiftyone.core.singletons.SampleSingleton._reload_doc

fiftyone.core.singletons.SampleSingleton.html#_reload_doc

Function

Method

PRIVATE

Reloads the backing document for the given sample if it is in-memory.
fiftyone.core.singletons.SampleSingleton._reload_docs

fiftyone.core.singletons.SampleSingleton.html#_reload_docs

Function

Method

PRIVATE

Reloads the backing documents for in-memory samples in the collection.
fiftyone.core.singletons.SampleSingleton._sync_docs

fiftyone.core.singletons.SampleSingleton.html#_sync_docs

Function

Method

PRIVATE

Syncs the backing documents for all in-memory samples in the collection according to the following rules:
fiftyone.core.singletons.SampleSingleton._reset_docs

fiftyone.core.singletons.SampleSingleton.html#_reset_docs

Function

Method

PRIVATE

Resets the backing documents for in-memory samples in the collection.
fiftyone.core.singletons.SampleSingleton._clear

fiftyone.core.singletons.SampleSingleton.html#_clear

Function

Method

PRIVATE

Removes all samples for the given collection from the cache.
fiftyone.core.singletons.FrameSingleton

fiftyone.core.singletons.FrameSingleton.html

Class

Class

PUBLIC

Singleton metaclass for fiftyone.core.frame.Frame.
fiftyone.core.singletons.FrameSingleton.__new__

fiftyone.core.singletons.FrameSingleton.html#__new__

Function

Method

PUBLIC

Undocumented
fiftyone.core.singletons.FrameSingleton._register_instance

fiftyone.core.singletons.FrameSingleton.html#_register_instance

Function

Method

PRIVATE

Registers the given instance in the weakref dictionary.
fiftyone.core.singletons.FrameSingleton._get_instance

fiftyone.core.singletons.FrameSingleton.html#_get_instance

Function

Method

PRIVATE

Retrieves the fiftyone.core.document.Document instance for the given document, if one exists.
fiftyone.core.singletons.FrameSingleton._reload_instance

fiftyone.core.singletons.FrameSingleton.html#_reload_instance

Function

Method

PRIVATE

Reloads the backing document for the given instance (or view), if a reference exists to it.
fiftyone.core.singletons.FrameSingleton._get_instances

fiftyone.core.singletons.FrameSingleton.html#_get_instances

Function

Method

PRIVATE

Returns a frame number -> Frame dict containing all in-memory frame instances for the specified sample.
fiftyone.core.singletons.FrameSingleton._rename_fields

fiftyone.core.singletons.FrameSingleton.html#_rename_fields

Function

Method

PRIVATE

Renames the field on all in-memory frames in the collection.
fiftyone.core.singletons.FrameSingleton._clear_fields

fiftyone.core.singletons.FrameSingleton.html#_clear_fields

Function

Method

PRIVATE

Clears the values for the given fields (i.e., sets them to None) on all in-memory frames in the collection.
fiftyone.core.singletons.FrameSingleton._purge_fields

fiftyone.core.singletons.FrameSingleton.html#_purge_fields

Function

Method

PRIVATE

Removes the fields from all in-memory frames in the collection.
fiftyone.core.singletons.FrameSingleton._reload_doc

fiftyone.core.singletons.FrameSingleton.html#_reload_doc

Function

Method

PRIVATE

Reloads the backing document for the given frame if it is in-memory.
fiftyone.core.singletons.FrameSingleton._sync_docs_for_sample

fiftyone.core.singletons.FrameSingleton.html#_sync_docs_for_sample

Function

Method

PRIVATE

Syncs the backing documents for all in-memory frames attached to the specified sample according to the following rules:
fiftyone.core.singletons.FrameSingleton._sync_docs

fiftyone.core.singletons.FrameSingleton.html#_sync_docs

Function

Method

PRIVATE

Syncs the backing documents for all in-memory frames according to the following rules:
fiftyone.core.singletons.FrameSingleton._reload_docs

fiftyone.core.singletons.FrameSingleton.html#_reload_docs

Function

Method

PRIVATE

Reloads the backing documents for in-memory frames in the collection.
fiftyone.core.singletons.FrameSingleton._reset_docs

fiftyone.core.singletons.FrameSingleton.html#_reset_docs

Function

Method

PRIVATE

Resets the backing documents for in-memory frames in the collection.
fiftyone.core.singletons.FrameSingleton._reset_docs_for_sample

fiftyone.core.singletons.FrameSingleton.html#_reset_docs_for_sample

Function

Method

PRIVATE

Resets the backing documents for all in-memory frames with the given frame numbers attached to the specified sample.
fiftyone.core.singletons.FrameSingleton._reset_docs_by_frame_id

fiftyone.core.singletons.FrameSingleton.html#_reset_docs_by_frame_id

Function

Method

PRIVATE

Resets the backing documents for all in-memory frames with the given frame IDs.
fiftyone.core.singletons.FrameSingleton._clear

fiftyone.core.singletons.FrameSingleton.html#_clear

Function

Method

PRIVATE

Removes all frames for the given collection from the cache.
fiftyone.core.dataset.fot

fiftyone.core.dataset.html#fot

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.dataset.foud

fiftyone.core.dataset.html#foud

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.dataset.foos

fiftyone.core.dataset.html#foos

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.dataset._SUMMARY_FIELD_KEY

fiftyone.core.dataset.html#_SUMMARY_FIELD_KEY

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.dataset.logger

fiftyone.core.dataset.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.dataset.DatasetNotFoundError

fiftyone.core.dataset.DatasetNotFoundError.html

Class

Exception

PUBLIC

Exception raised when a dataset is not found.
fiftyone.core.dataset.DatasetNotFoundError.__init__

fiftyone.core.dataset.DatasetNotFoundError.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.DatasetNotFoundError._dataset_name

fiftyone.core.dataset.DatasetNotFoundError.html#_dataset_name

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.dataset.list_datasets

fiftyone.core.dataset.html#list_datasets

Function

Function

PUBLIC

Lists the available FiftyOne datasets.
fiftyone.core.dataset.dataset_exists

fiftyone.core.dataset.html#dataset_exists

Function

Function

PUBLIC

Checks if the dataset exists.
fiftyone.core.dataset._validate_dataset_name

fiftyone.core.dataset.html#_validate_dataset_name

Function

Function

PRIVATE

Validates that the given dataset name is available.
fiftyone.core.dataset.load_dataset

fiftyone.core.dataset.html#load_dataset

Function

Function

PUBLIC

Loads the FiftyOne dataset with the given name.
fiftyone.core.dataset.get_default_dataset_name

fiftyone.core.dataset.html#get_default_dataset_name

Function

Function

PUBLIC

Returns a default dataset name based on the current time.
fiftyone.core.dataset.make_unique_dataset_name

fiftyone.core.dataset.html#make_unique_dataset_name

Function

Function

PUBLIC

Makes a unique dataset name with the given root name.
fiftyone.core.dataset.get_default_dataset_dir

fiftyone.core.dataset.html#get_default_dataset_dir

Function

Function

PUBLIC

Returns the default dataset directory for the dataset with the given name.
fiftyone.core.dataset.delete_dataset

fiftyone.core.dataset.html#delete_dataset

Function

Function

PUBLIC

Deletes the FiftyOne dataset with the given name.
fiftyone.core.dataset.delete_datasets

fiftyone.core.dataset.html#delete_datasets

Function

Function

PUBLIC

Deletes all FiftyOne datasets whose names match the given glob pattern.
fiftyone.core.dataset.delete_non_persistent_datasets

fiftyone.core.dataset.html#delete_non_persistent_datasets

Function

Function

PUBLIC

Deletes all non-persistent datasets.
fiftyone.core.dataset._delete_non_persistent_datasets

fiftyone.core.dataset.html#_delete_non_persistent_datasets

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset

fiftyone.core.dataset.Dataset.html

Class

Class

PUBLIC

A FiftyOne dataset.
fiftyone.core.dataset.Dataset.__slots__

fiftyone.core.dataset.Dataset.html#__slots__

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.__init__

fiftyone.core.dataset.Dataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset._doc

fiftyone.core.dataset.Dataset.html#_doc

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._sample_doc_cls

fiftyone.core.dataset.Dataset.html#_sample_doc_cls

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._frame_doc_cls

fiftyone.core.dataset.Dataset.html#_frame_doc_cls

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._group_slice

fiftyone.core.dataset.Dataset.html#_group_slice

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._annotation_cache

fiftyone.core.dataset.Dataset.html#_annotation_cache

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._brain_cache

fiftyone.core.dataset.Dataset.html#_brain_cache

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._evaluation_cache

fiftyone.core.dataset.Dataset.html#_evaluation_cache

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._run_cache

fiftyone.core.dataset.Dataset.html#_run_cache

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._deleted

fiftyone.core.dataset.Dataset.html#_deleted

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.__eq__

fiftyone.core.dataset.Dataset.html#__eq__

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.__copy__

fiftyone.core.dataset.Dataset.html#__copy__

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.__deepcopy__

fiftyone.core.dataset.Dataset.html#__deepcopy__

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.__len__

fiftyone.core.dataset.Dataset.html#__len__

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset._estimated_count

fiftyone.core.dataset.Dataset.html#_estimated_count

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.__getitem__

fiftyone.core.dataset.Dataset.html#__getitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.__delitem__

fiftyone.core.dataset.Dataset.html#__delitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.__getattribute__

fiftyone.core.dataset.Dataset.html#__getattribute__

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset._dataset

fiftyone.core.dataset.Dataset.html#_dataset

Attribute

Property

PRIVATE

The fiftyone.core.dataset.Dataset that serves the samples in this collection.
fiftyone.core.dataset.Dataset._root_dataset

fiftyone.core.dataset.Dataset.html#_root_dataset

Attribute

Property

PRIVATE

The root fiftyone.core.dataset.Dataset from which this collection is derived.
fiftyone.core.dataset.Dataset._is_generated

fiftyone.core.dataset.Dataset.html#_is_generated

Attribute

Property

PRIVATE

Whether this collection's contents is generated from another collection.
fiftyone.core.dataset.Dataset._is_patches

fiftyone.core.dataset.Dataset.html#_is_patches

Attribute

Property

PRIVATE

Whether this collection contains patches.
fiftyone.core.dataset.Dataset._is_frames

fiftyone.core.dataset.Dataset.html#_is_frames

Attribute

Property

PRIVATE

Whether this collection contains frames of a video dataset.
fiftyone.core.dataset.Dataset._is_clips

fiftyone.core.dataset.Dataset.html#_is_clips

Attribute

Property

PRIVATE

Whether this collection contains clips.
fiftyone.core.dataset.Dataset._is_dynamic_groups

fiftyone.core.dataset.Dataset.html#_is_dynamic_groups

Attribute

Property

PRIVATE

Whether this collection contains dynamic groups.
fiftyone.core.dataset.Dataset.media_type

fiftyone.core.dataset.Dataset.html#media_type

Attribute

Instance Variable

PUBLIC

The media type of the dataset.
fiftyone.core.dataset.Dataset.media_type.setter

fiftyone.core.dataset.Dataset.html#media_type.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset._set_media_type

fiftyone.core.dataset.Dataset.html#_set_media_type

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._update_metadata_field

fiftyone.core.dataset.Dataset.html#_update_metadata_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._init_frames

fiftyone.core.dataset.Dataset.html#_init_frames

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.group_field

fiftyone.core.dataset.Dataset.html#group_field

Attribute

Property

PUBLIC

The group field of the dataset, or None if the dataset is not grouped.
fiftyone.core.dataset.Dataset.group_slice

fiftyone.core.dataset.Dataset.html#group_slice

Attribute

Instance Variable

PUBLIC

The current group slice of the dataset, or None if the dataset is not grouped.
fiftyone.core.dataset.Dataset.group_slice.setter

fiftyone.core.dataset.Dataset.html#group_slice.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.group_slices

fiftyone.core.dataset.Dataset.html#group_slices

Attribute

Property

PUBLIC

The list of group slices of the dataset, or None if the dataset is not grouped.
fiftyone.core.dataset.Dataset.group_media_types

fiftyone.core.dataset.Dataset.html#group_media_types

Attribute

Property

PUBLIC

A dict mapping group slices to media types, or None if the dataset is not grouped.
fiftyone.core.dataset.Dataset.default_group_slice

fiftyone.core.dataset.Dataset.html#default_group_slice

Attribute

Property

PUBLIC

The default group slice of the dataset, or None if the dataset is not grouped.
fiftyone.core.dataset.Dataset.default_group_slice.setter

fiftyone.core.dataset.Dataset.html#default_group_slice.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.version

fiftyone.core.dataset.Dataset.html#version

Attribute

Property

PUBLIC

The version of the fiftyone package for which the dataset is formatted.
fiftyone.core.dataset.Dataset.name

fiftyone.core.dataset.Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.core.dataset.Dataset.name.setter

fiftyone.core.dataset.Dataset.html#name.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.slug

fiftyone.core.dataset.Dataset.html#slug

Attribute

Property

PUBLIC

The slug of the dataset.
fiftyone.core.dataset.Dataset.created_at

fiftyone.core.dataset.Dataset.html#created_at

Attribute

Property

PUBLIC

The datetime that the dataset was created.
fiftyone.core.dataset.Dataset.last_modified_at

fiftyone.core.dataset.Dataset.html#last_modified_at

Attribute

Property

PUBLIC

The datetime that the dataset was last modified.
fiftyone.core.dataset.Dataset.last_loaded_at

fiftyone.core.dataset.Dataset.html#last_loaded_at

Attribute

Property

PUBLIC

The datetime that the dataset was last loaded.
fiftyone.core.dataset.Dataset.persistent

fiftyone.core.dataset.Dataset.html#persistent

Attribute

Property

PUBLIC

Whether the dataset persists in the database after a session is terminated.
fiftyone.core.dataset.Dataset.persistent.setter

fiftyone.core.dataset.Dataset.html#persistent.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.tags

fiftyone.core.dataset.Dataset.html#tags

Attribute

Property

PUBLIC

A list of tags on the dataset.
fiftyone.core.dataset.Dataset.tags.setter

fiftyone.core.dataset.Dataset.html#tags.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.description

fiftyone.core.dataset.Dataset.html#description

Attribute

Property

PUBLIC

A string description on the dataset.
fiftyone.core.dataset.Dataset.description.setter

fiftyone.core.dataset.Dataset.html#description.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.info

fiftyone.core.dataset.Dataset.html#info

Attribute

Property

PUBLIC

A user-facing dictionary of information about the dataset.
fiftyone.core.dataset.Dataset.info.setter

fiftyone.core.dataset.Dataset.html#info.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.app_config

fiftyone.core.dataset.Dataset.html#app_config

Attribute

Property

PUBLIC

A fiftyone.core.odm.dataset.DatasetAppConfig that customizes how this dataset is visualized in the :ref:`FiftyOne App <fiftyone-app>`.
fiftyone.core.dataset.Dataset.app_config.setter

fiftyone.core.dataset.Dataset.html#app_config.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.classes

fiftyone.core.dataset.Dataset.html#classes

Attribute

Property

PUBLIC

A dict mapping field names to list of class label strings for the corresponding fields of the dataset.
fiftyone.core.dataset.Dataset.classes.setter

fiftyone.core.dataset.Dataset.html#classes.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.default_classes

fiftyone.core.dataset.Dataset.html#default_classes

Attribute

Property

PUBLIC

A list of class label strings for all fiftyone.core.labels.Label fields of this dataset that do not have customized classes defined in classes.
fiftyone.core.dataset.Dataset.default_classes.setter

fiftyone.core.dataset.Dataset.html#default_classes.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.mask_targets

fiftyone.core.dataset.Dataset.html#mask_targets

Attribute

Property

PUBLIC

A dict mapping field names to mask target dicts, each of which defines a mapping between pixel values (2D masks) or RGB hex strings (3D masks) and label strings for the segmentation masks in the corresponding field of the dataset.
fiftyone.core.dataset.Dataset.mask_targets.setter

fiftyone.core.dataset.Dataset.html#mask_targets.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.default_mask_targets

fiftyone.core.dataset.Dataset.html#default_mask_targets

Attribute

Property

PUBLIC

A dict defining a default mapping between pixel values (2D masks) or RGB hex strings (3D masks) and label strings for the segmentation masks of all fiftyone.core.labels.Segmentation fields of this dataset that do not have customized mask targets defined in ...
fiftyone.core.dataset.Dataset.default_mask_targets.setter

fiftyone.core.dataset.Dataset.html#default_mask_targets.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.skeletons

fiftyone.core.dataset.Dataset.html#skeletons

Attribute

Property

PUBLIC

A dict mapping field names to fiftyone.core.odm.dataset.KeypointSkeleton instances, each of which defines the semantic labels and point connectivity for the fiftyone.core.labels.Keypoint instances in the corresponding field of the dataset.
fiftyone.core.dataset.Dataset.skeletons.setter

fiftyone.core.dataset.Dataset.html#skeletons.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.default_skeleton

fiftyone.core.dataset.Dataset.html#default_skeleton

Attribute

Property

PUBLIC

A default fiftyone.core.odm.dataset.KeypointSkeleton defining the semantic labels and point connectivity for all fiftyone.core.labels.Keypoint fields of this dataset that do not have customized skeletons defined in ...
fiftyone.core.dataset.Dataset.default_skeleton.setter

fiftyone.core.dataset.Dataset.html#default_skeleton.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.dataset.Dataset.deleted

fiftyone.core.dataset.Dataset.html#deleted

Attribute

Property

PUBLIC

Whether the dataset is deleted.
fiftyone.core.dataset.Dataset.summary

fiftyone.core.dataset.Dataset.html#summary

Function

Method

PUBLIC

Returns a string summary of the dataset.
fiftyone.core.dataset.Dataset.stats

fiftyone.core.dataset.Dataset.html#stats

Function

Method

PUBLIC

Returns stats about the dataset on disk.
fiftyone.core.dataset.Dataset._sample_collstats

fiftyone.core.dataset.Dataset.html#_sample_collstats

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._frame_collstats

fiftyone.core.dataset.Dataset.html#_frame_collstats

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.first

fiftyone.core.dataset.Dataset.html#first

Function

Method

PUBLIC

Returns the first sample in the dataset.
fiftyone.core.dataset.Dataset.last

fiftyone.core.dataset.Dataset.html#last

Function

Method

PUBLIC

Returns the last sample in the dataset.
fiftyone.core.dataset.Dataset.head

fiftyone.core.dataset.Dataset.html#head

Function

Method

PUBLIC

Returns a list of the first few samples in the dataset.
fiftyone.core.dataset.Dataset.tail

fiftyone.core.dataset.Dataset.html#tail

Function

Method

PUBLIC

Returns a list of the last few samples in the dataset.
fiftyone.core.dataset.Dataset.one

fiftyone.core.dataset.Dataset.html#one

Function

Method

PUBLIC

Returns a single sample in this dataset matching the expression.
fiftyone.core.dataset.Dataset.view

fiftyone.core.dataset.Dataset.html#view

Function

Method

PUBLIC

Returns a fiftyone.core.view.DatasetView containing the entire dataset.
fiftyone.core.dataset.Dataset.get_field_schema

fiftyone.core.dataset.Dataset.html#get_field_schema

Function

Method

PUBLIC

Returns a schema dictionary describing the fields of the samples in the dataset.
fiftyone.core.dataset.Dataset.get_frame_field_schema

fiftyone.core.dataset.Dataset.html#get_frame_field_schema

Function

Method

PUBLIC

Returns a schema dictionary describing the fields of the frames of the samples in the dataset.
fiftyone.core.dataset.Dataset.add_sample_field

fiftyone.core.dataset.Dataset.html#add_sample_field

Function

Method

PUBLIC

Adds a new sample field or embedded field to the dataset, if necessary.
fiftyone.core.dataset.Dataset._add_implied_sample_field

fiftyone.core.dataset.Dataset.html#_add_implied_sample_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._merge_sample_field_schema

fiftyone.core.dataset.Dataset.html#_merge_sample_field_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.add_dynamic_sample_fields

fiftyone.core.dataset.Dataset.html#add_dynamic_sample_fields

Function

Method

PUBLIC

Adds all dynamic sample fields to the dataset's schema.
fiftyone.core.dataset.Dataset.add_frame_field

fiftyone.core.dataset.Dataset.html#add_frame_field

Function

Method

PUBLIC

Adds a new frame-level field or embedded field to the dataset, if necessary.
fiftyone.core.dataset.Dataset.list_summary_fields

fiftyone.core.dataset.Dataset.html#list_summary_fields

Function

Method

PUBLIC

Lists the summary fields on the dataset.
fiftyone.core.dataset.Dataset._get_summarized_fields_map

fiftyone.core.dataset.Dataset.html#_get_summarized_fields_map

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.create_summary_field

fiftyone.core.dataset.Dataset.html#create_summary_field

Function

Method

PUBLIC

Populates a sample-level field that records the unique values or numeric ranges that appear in the specified field on each sample in the dataset.
fiftyone.core.dataset.Dataset._get_default_summary_field_name

fiftyone.core.dataset.Dataset.html#_get_default_summary_field_name

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._populate_summary_field

fiftyone.core.dataset.Dataset.html#_populate_summary_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.check_summary_fields

fiftyone.core.dataset.Dataset.html#check_summary_fields

Function

Method

PUBLIC

Returns a list of summary fields that may need to be updated.
fiftyone.core.dataset.Dataset.update_summary_field

fiftyone.core.dataset.Dataset.html#update_summary_field

Function

Method

PUBLIC

Updates the summary field based on the current values of its source field.
fiftyone.core.dataset.Dataset.delete_summary_field

fiftyone.core.dataset.Dataset.html#delete_summary_field

Function

Method

PUBLIC

Deletes the summary field from all samples in the dataset.
fiftyone.core.dataset.Dataset.delete_summary_fields

fiftyone.core.dataset.Dataset.html#delete_summary_fields

Function

Method

PUBLIC

Deletes the summary fields from all samples in the dataset.
fiftyone.core.dataset.Dataset._delete_summary_fields

fiftyone.core.dataset.Dataset.html#_delete_summary_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._add_implied_frame_field

fiftyone.core.dataset.Dataset.html#_add_implied_frame_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._merge_frame_field_schema

fiftyone.core.dataset.Dataset.html#_merge_frame_field_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.add_dynamic_frame_fields

fiftyone.core.dataset.Dataset.html#add_dynamic_frame_fields

Function

Method

PUBLIC

Adds all dynamic frame fields to the dataset's schema.
fiftyone.core.dataset.Dataset.add_group_field

fiftyone.core.dataset.Dataset.html#add_group_field

Function

Method

PUBLIC

Adds a group field to the dataset, if necessary.
fiftyone.core.dataset.Dataset._add_group_field

fiftyone.core.dataset.Dataset.html#_add_group_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.rename_sample_field

fiftyone.core.dataset.Dataset.html#rename_sample_field

Function

Method

PUBLIC

Renames the sample field to the given new name.
fiftyone.core.dataset.Dataset.rename_sample_fields

fiftyone.core.dataset.Dataset.html#rename_sample_fields

Function

Method

PUBLIC

Renames the sample fields to the given new names.
fiftyone.core.dataset.Dataset.rename_frame_field

fiftyone.core.dataset.Dataset.html#rename_frame_field

Function

Method

PUBLIC

Renames the frame-level field to the given new name.
fiftyone.core.dataset.Dataset.rename_frame_fields

fiftyone.core.dataset.Dataset.html#rename_frame_fields

Function

Method

PUBLIC

Renames the frame-level fields to the given new names.
fiftyone.core.dataset.Dataset._rename_sample_fields

fiftyone.core.dataset.Dataset.html#_rename_sample_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._rename_frame_fields

fiftyone.core.dataset.Dataset.html#_rename_frame_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.clone_sample_field

fiftyone.core.dataset.Dataset.html#clone_sample_field

Function

Method

PUBLIC

Clones the given sample field into a new field of the dataset.
fiftyone.core.dataset.Dataset.clone_sample_fields

fiftyone.core.dataset.Dataset.html#clone_sample_fields

Function

Method

PUBLIC

Clones the given sample fields into new fields of the dataset.
fiftyone.core.dataset.Dataset.clone_frame_field

fiftyone.core.dataset.Dataset.html#clone_frame_field

Function

Method

PUBLIC

Clones the frame-level field into a new field.
fiftyone.core.dataset.Dataset.clone_frame_fields

fiftyone.core.dataset.Dataset.html#clone_frame_fields

Function

Method

PUBLIC

Clones the frame-level fields into new fields.
fiftyone.core.dataset.Dataset._clone_sample_fields

fiftyone.core.dataset.Dataset.html#_clone_sample_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._clone_frame_fields

fiftyone.core.dataset.Dataset.html#_clone_frame_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.clear_sample_field

fiftyone.core.dataset.Dataset.html#clear_sample_field

Function

Method

PUBLIC

Clears the values of the field from all samples in the dataset.
fiftyone.core.dataset.Dataset.clear_sample_fields

fiftyone.core.dataset.Dataset.html#clear_sample_fields

Function

Method

PUBLIC

Clears the values of the fields from all samples in the dataset.
fiftyone.core.dataset.Dataset.clear_frame_field

fiftyone.core.dataset.Dataset.html#clear_frame_field

Function

Method

PUBLIC

Clears the values of the frame-level field from all samples in the dataset.
fiftyone.core.dataset.Dataset.clear_frame_fields

fiftyone.core.dataset.Dataset.html#clear_frame_fields

Function

Method

PUBLIC

Clears the values of the frame-level fields from all samples in the dataset.
fiftyone.core.dataset.Dataset._clear_sample_fields

fiftyone.core.dataset.Dataset.html#_clear_sample_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._clear_frame_fields

fiftyone.core.dataset.Dataset.html#_clear_frame_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.delete_sample_field

fiftyone.core.dataset.Dataset.html#delete_sample_field

Function

Method

PUBLIC

Deletes the field from all samples in the dataset.
fiftyone.core.dataset.Dataset.delete_sample_fields

fiftyone.core.dataset.Dataset.html#delete_sample_fields

Function

Method

PUBLIC

Deletes the fields from all samples in the dataset.
fiftyone.core.dataset.Dataset.remove_dynamic_sample_field

fiftyone.core.dataset.Dataset.html#remove_dynamic_sample_field

Function

Method

PUBLIC

Removes the dynamic embedded sample field from the dataset's schema.
fiftyone.core.dataset.Dataset.remove_dynamic_sample_fields

fiftyone.core.dataset.Dataset.html#remove_dynamic_sample_fields

Function

Method

PUBLIC

Removes the dynamic embedded sample fields from the dataset's schema.
fiftyone.core.dataset.Dataset.delete_frame_field

fiftyone.core.dataset.Dataset.html#delete_frame_field

Function

Method

PUBLIC

Deletes the frame-level field from all samples in the dataset.
fiftyone.core.dataset.Dataset.delete_frame_fields

fiftyone.core.dataset.Dataset.html#delete_frame_fields

Function

Method

PUBLIC

Deletes the frame-level fields from all samples in the dataset.
fiftyone.core.dataset.Dataset.remove_dynamic_frame_field

fiftyone.core.dataset.Dataset.html#remove_dynamic_frame_field

Function

Method

PUBLIC

Removes the dynamic embedded frame field from the dataset's schema.
fiftyone.core.dataset.Dataset.remove_dynamic_frame_fields

fiftyone.core.dataset.Dataset.html#remove_dynamic_frame_fields

Function

Method

PUBLIC

Removes the dynamic embedded frame fields from the dataset's schema.
fiftyone.core.dataset.Dataset._delete_sample_fields

fiftyone.core.dataset.Dataset.html#_delete_sample_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._remove_dynamic_sample_fields

fiftyone.core.dataset.Dataset.html#_remove_dynamic_sample_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._delete_frame_fields

fiftyone.core.dataset.Dataset.html#_delete_frame_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._remove_dynamic_frame_fields

fiftyone.core.dataset.Dataset.html#_remove_dynamic_frame_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.add_group_slice

fiftyone.core.dataset.Dataset.html#add_group_slice

Function

Method

PUBLIC

Adds a group slice with the given media type to the dataset, if necessary.
fiftyone.core.dataset.Dataset.rename_group_slice

fiftyone.core.dataset.Dataset.html#rename_group_slice

Function

Method

PUBLIC

Renames the group slice with the given name.
fiftyone.core.dataset.Dataset.delete_group_slice

fiftyone.core.dataset.Dataset.html#delete_group_slice

Function

Method

PUBLIC

Deletes all samples in the given group slice from the dataset.
fiftyone.core.dataset.Dataset.iter_samples

fiftyone.core.dataset.Dataset.html#iter_samples

Function

Method

PUBLIC

Returns an iterator over the samples in the dataset.
fiftyone.core.dataset.Dataset._iter_samples

fiftyone.core.dataset.Dataset.html#_iter_samples

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.iter_groups

fiftyone.core.dataset.Dataset.html#iter_groups

Function

Method

PUBLIC

Returns an iterator over the groups in the dataset.
fiftyone.core.dataset.Dataset._iter_groups

fiftyone.core.dataset.Dataset.html#_iter_groups

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.get_group

fiftyone.core.dataset.Dataset.html#get_group

Function

Method

PUBLIC

Returns a dict containing the samples for the given group ID.
fiftyone.core.dataset.Dataset.add_sample

fiftyone.core.dataset.Dataset.html#add_sample

Function

Method

PUBLIC

Adds the given sample to the dataset.
fiftyone.core.dataset.Dataset.add_samples

fiftyone.core.dataset.Dataset.html#add_samples

Function

Method

PUBLIC

Adds the given samples to the dataset.
fiftyone.core.dataset.Dataset.add_collection

fiftyone.core.dataset.Dataset.html#add_collection

Function

Method

PUBLIC

Adds the contents of the given collection to the dataset.
fiftyone.core.dataset.Dataset._add_samples_batch

fiftyone.core.dataset.Dataset.html#_add_samples_batch

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._upsert_samples

fiftyone.core.dataset.Dataset.html#_upsert_samples

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._upsert_samples_batch

fiftyone.core.dataset.Dataset.html#_upsert_samples_batch

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._make_dict

fiftyone.core.dataset.Dataset.html#_make_dict

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._bulk_write

fiftyone.core.dataset.Dataset.html#_bulk_write

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._merge_doc

fiftyone.core.dataset.Dataset.html#_merge_doc

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.merge_sample

fiftyone.core.dataset.Dataset.html#merge_sample

Function

Method

PUBLIC

Merges the fields of the given sample into this dataset.
fiftyone.core.dataset.Dataset.merge_samples

fiftyone.core.dataset.Dataset.html#merge_samples

Function

Method

PUBLIC

Merges the given samples into this dataset.
fiftyone.core.dataset.Dataset.delete_samples

fiftyone.core.dataset.Dataset.html#delete_samples

Function

Method

PUBLIC

Deletes the given sample(s) from the dataset.
fiftyone.core.dataset.Dataset.delete_frames

fiftyone.core.dataset.Dataset.html#delete_frames

Function

Method

PUBLIC

Deletes the given frames(s) from the dataset.
fiftyone.core.dataset.Dataset.delete_groups

fiftyone.core.dataset.Dataset.html#delete_groups

Function

Method

PUBLIC

Deletes the given groups(s) from the dataset.
fiftyone.core.dataset.Dataset.delete_labels

fiftyone.core.dataset.Dataset.html#delete_labels

Function

Method

PUBLIC

Deletes the specified labels from the dataset.
fiftyone.core.dataset.Dataset._delete_labels

fiftyone.core.dataset.Dataset.html#_delete_labels

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.save

fiftyone.core.dataset.Dataset.html#save

Function

Method

PUBLIC

Saves the dataset to the database.
fiftyone.core.dataset.Dataset._save

fiftyone.core.dataset.Dataset.html#_save

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._save_field

fiftyone.core.dataset.Dataset.html#_save_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.has_saved_views

fiftyone.core.dataset.Dataset.html#has_saved_views

Attribute

Property

PUBLIC

Whether this dataset has any saved views.
fiftyone.core.dataset.Dataset.has_saved_view

fiftyone.core.dataset.Dataset.html#has_saved_view

Function

Method

PUBLIC

Whether this dataset has a saved view with the given name.
fiftyone.core.dataset.Dataset.list_saved_views

fiftyone.core.dataset.Dataset.html#list_saved_views

Function

Method

PUBLIC

List saved views on this dataset.
fiftyone.core.dataset.Dataset.save_view

fiftyone.core.dataset.Dataset.html#save_view

Function

Method

PUBLIC

Saves the given view into this dataset under the given name so it can be loaded later via load_saved_view.
fiftyone.core.dataset.Dataset.get_saved_view_info

fiftyone.core.dataset.Dataset.html#get_saved_view_info

Function

Method

PUBLIC

Loads the editable information about the saved view with the given name.
fiftyone.core.dataset.Dataset.update_saved_view_info

fiftyone.core.dataset.Dataset.html#update_saved_view_info

Function

Method

PUBLIC

Updates the editable information for the saved view with the given name.
fiftyone.core.dataset.Dataset.load_saved_view

fiftyone.core.dataset.Dataset.html#load_saved_view

Function

Method

PUBLIC

Loads the saved view with the given name.
fiftyone.core.dataset.Dataset.delete_saved_view

fiftyone.core.dataset.Dataset.html#delete_saved_view

Function

Method

PUBLIC

Deletes the saved view with the given name.
fiftyone.core.dataset.Dataset.delete_saved_views

fiftyone.core.dataset.Dataset.html#delete_saved_views

Function

Method

PUBLIC

Deletes all saved views from this dataset.
fiftyone.core.dataset.Dataset._delete_saved_view

fiftyone.core.dataset.Dataset.html#_delete_saved_view

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._get_saved_view_doc

fiftyone.core.dataset.Dataset.html#_get_saved_view_doc

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._load_saved_view_from_doc

fiftyone.core.dataset.Dataset.html#_load_saved_view_from_doc

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._validate_saved_view_name

fiftyone.core.dataset.Dataset.html#_validate_saved_view_name

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.has_workspaces

fiftyone.core.dataset.Dataset.html#has_workspaces

Attribute

Property

PUBLIC

Whether this dataset has any saved workspaces.
fiftyone.core.dataset.Dataset.has_workspace

fiftyone.core.dataset.Dataset.html#has_workspace

Function

Method

PUBLIC

Whether this dataset has a saved workspace with the given name.
fiftyone.core.dataset.Dataset.list_workspaces

fiftyone.core.dataset.Dataset.html#list_workspaces

Function

Method

PUBLIC

List saved workspaces on this dataset.
fiftyone.core.dataset.Dataset.save_workspace

fiftyone.core.dataset.Dataset.html#save_workspace

Function

Method

PUBLIC

Saves a workspace into this dataset under the given name so it can be loaded later via load_workspace.
fiftyone.core.dataset.Dataset.load_workspace

fiftyone.core.dataset.Dataset.html#load_workspace

Function

Method

PUBLIC

Loads the saved workspace with the given name.
fiftyone.core.dataset.Dataset.get_workspace_info

fiftyone.core.dataset.Dataset.html#get_workspace_info

Function

Method

PUBLIC

Gets the information about the workspace with the given name.
fiftyone.core.dataset.Dataset.update_workspace_info

fiftyone.core.dataset.Dataset.html#update_workspace_info

Function

Method

PUBLIC

Updates the editable information for the saved view with the given name.
fiftyone.core.dataset.Dataset.delete_workspace

fiftyone.core.dataset.Dataset.html#delete_workspace

Function

Method

PUBLIC

Deletes the saved workspace with the given name.
fiftyone.core.dataset.Dataset.delete_workspaces

fiftyone.core.dataset.Dataset.html#delete_workspaces

Function

Method

PUBLIC

Deletes all saved workspaces from this dataset.
fiftyone.core.dataset.Dataset._delete_workspace

fiftyone.core.dataset.Dataset.html#_delete_workspace

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._get_workspace_doc

fiftyone.core.dataset.Dataset.html#_get_workspace_doc

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._validate_workspace_name

fiftyone.core.dataset.Dataset.html#_validate_workspace_name

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.clone

fiftyone.core.dataset.Dataset.html#clone

Function

Method

PUBLIC

Creates a copy of the dataset.
fiftyone.core.dataset.Dataset._clone

fiftyone.core.dataset.Dataset.html#_clone

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.clear

fiftyone.core.dataset.Dataset.html#clear

Function

Method

PUBLIC

Removes all samples from the dataset.
fiftyone.core.dataset.Dataset._clear

fiftyone.core.dataset.Dataset.html#_clear

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._clear_groups

fiftyone.core.dataset.Dataset.html#_clear_groups

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._keep

fiftyone.core.dataset.Dataset.html#_keep

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._keep_fields

fiftyone.core.dataset.Dataset.html#_keep_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.clear_frames

fiftyone.core.dataset.Dataset.html#clear_frames

Function

Method

PUBLIC

Removes all frame labels from the dataset.
fiftyone.core.dataset.Dataset._clear_frames

fiftyone.core.dataset.Dataset.html#_clear_frames

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._keep_frames

fiftyone.core.dataset.Dataset.html#_keep_frames

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.ensure_frames

fiftyone.core.dataset.Dataset.html#ensure_frames

Function

Method

PUBLIC

Ensures that the video dataset contains frame instances for every frame of each sample's source video.
fiftyone.core.dataset.Dataset._ensure_frames

fiftyone.core.dataset.Dataset.html#_ensure_frames

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.delete

fiftyone.core.dataset.Dataset.html#delete

Function

Method

PUBLIC

Deletes the dataset.
fiftyone.core.dataset.Dataset._delete

fiftyone.core.dataset.Dataset.html#_delete

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.add_dir

fiftyone.core.dataset.Dataset.html#add_dir

Function

Method

PUBLIC

Adds the contents of the given directory to the dataset.
fiftyone.core.dataset.Dataset.merge_dir

fiftyone.core.dataset.Dataset.html#merge_dir

Function

Method

PUBLIC

Merges the contents of the given directory into the dataset.
fiftyone.core.dataset.Dataset.add_archive

fiftyone.core.dataset.Dataset.html#add_archive

Function

Method

PUBLIC

Adds the contents of the given archive to the dataset.
fiftyone.core.dataset.Dataset.merge_archive

fiftyone.core.dataset.Dataset.html#merge_archive

Function

Method

PUBLIC

Merges the contents of the given archive into the dataset.
fiftyone.core.dataset.Dataset.add_importer

fiftyone.core.dataset.Dataset.html#add_importer

Function

Method

PUBLIC

Adds the samples from the given fiftyone.utils.data.importers.DatasetImporter to the dataset.
fiftyone.core.dataset.Dataset.merge_importer

fiftyone.core.dataset.Dataset.html#merge_importer

Function

Method

PUBLIC

Merges the samples from the given fiftyone.utils.data.importers.DatasetImporter into the dataset.
fiftyone.core.dataset.Dataset.add_images

fiftyone.core.dataset.Dataset.html#add_images

Function

Method

PUBLIC

Adds the given images to the dataset.
fiftyone.core.dataset.Dataset.add_labeled_images

fiftyone.core.dataset.Dataset.html#add_labeled_images

Function

Method

PUBLIC

Adds the given labeled images to the dataset.
fiftyone.core.dataset.Dataset.add_images_dir

fiftyone.core.dataset.Dataset.html#add_images_dir

Function

Method

PUBLIC

Adds the given directory of images to the dataset.
fiftyone.core.dataset.Dataset.add_images_patt

fiftyone.core.dataset.Dataset.html#add_images_patt

Function

Method

PUBLIC

Adds the given glob pattern of images to the dataset.
fiftyone.core.dataset.Dataset.ingest_images

fiftyone.core.dataset.Dataset.html#ingest_images

Function

Method

PUBLIC

Ingests the given iterable of images into the dataset.
fiftyone.core.dataset.Dataset.ingest_labeled_images

fiftyone.core.dataset.Dataset.html#ingest_labeled_images

Function

Method

PUBLIC

Ingests the given iterable of labeled image samples into the dataset.
fiftyone.core.dataset.Dataset.add_videos

fiftyone.core.dataset.Dataset.html#add_videos

Function

Method

PUBLIC

Adds the given videos to the dataset.
fiftyone.core.dataset.Dataset.add_labeled_videos

fiftyone.core.dataset.Dataset.html#add_labeled_videos

Function

Method

PUBLIC

Adds the given labeled videos to the dataset.
fiftyone.core.dataset.Dataset.add_videos_dir

fiftyone.core.dataset.Dataset.html#add_videos_dir

Function

Method

PUBLIC

Adds the given directory of videos to the dataset.
fiftyone.core.dataset.Dataset.add_videos_patt

fiftyone.core.dataset.Dataset.html#add_videos_patt

Function

Method

PUBLIC

Adds the given glob pattern of videos to the dataset.
fiftyone.core.dataset.Dataset.ingest_videos

fiftyone.core.dataset.Dataset.html#ingest_videos

Function

Method

PUBLIC

Ingests the given iterable of videos into the dataset.
fiftyone.core.dataset.Dataset.ingest_labeled_videos

fiftyone.core.dataset.Dataset.html#ingest_labeled_videos

Function

Method

PUBLIC

Ingests the given iterable of labeled video samples into the dataset.
fiftyone.core.dataset.Dataset.from_dir

fiftyone.core.dataset.Dataset.html#from_dir

Function

Class Method

PUBLIC

Creates a Dataset from the contents of the given directory.
fiftyone.core.dataset.Dataset.from_archive

fiftyone.core.dataset.Dataset.html#from_archive

Function

Class Method

PUBLIC

Creates a Dataset from the contents of the given archive.
fiftyone.core.dataset.Dataset.from_importer

fiftyone.core.dataset.Dataset.html#from_importer

Function

Class Method

PUBLIC

Creates a Dataset by importing the samples in the given fiftyone.utils.data.importers.DatasetImporter.
fiftyone.core.dataset.Dataset.from_images

fiftyone.core.dataset.Dataset.html#from_images

Function

Class Method

PUBLIC

Creates a Dataset from the given images.
fiftyone.core.dataset.Dataset.from_labeled_images

fiftyone.core.dataset.Dataset.html#from_labeled_images

Function

Class Method

PUBLIC

Creates a Dataset from the given labeled images.
fiftyone.core.dataset.Dataset.from_images_dir

fiftyone.core.dataset.Dataset.html#from_images_dir

Function

Class Method

PUBLIC

Creates a Dataset from the given directory of images.
fiftyone.core.dataset.Dataset.from_images_patt

fiftyone.core.dataset.Dataset.html#from_images_patt

Function

Class Method

PUBLIC

Creates a Dataset from the given glob pattern of images.
fiftyone.core.dataset.Dataset.from_videos

fiftyone.core.dataset.Dataset.html#from_videos

Function

Class Method

PUBLIC

Creates a Dataset from the given videos.
fiftyone.core.dataset.Dataset.from_labeled_videos

fiftyone.core.dataset.Dataset.html#from_labeled_videos

Function

Class Method

PUBLIC

Creates a Dataset from the given labeled videos.
fiftyone.core.dataset.Dataset.from_videos_dir

fiftyone.core.dataset.Dataset.html#from_videos_dir

Function

Class Method

PUBLIC

Creates a Dataset from the given directory of videos.
fiftyone.core.dataset.Dataset.from_videos_patt

fiftyone.core.dataset.Dataset.html#from_videos_patt

Function

Class Method

PUBLIC

Creates a Dataset from the given glob pattern of videos.
fiftyone.core.dataset.Dataset.from_dict

fiftyone.core.dataset.Dataset.html#from_dict

Function

Class Method

PUBLIC

Loads a Dataset from a JSON dictionary generated by fiftyone.core.collections.SampleCollection.to_dict.
fiftyone.core.dataset.Dataset.from_json

fiftyone.core.dataset.Dataset.html#from_json

Function

Class Method

PUBLIC

Loads a Dataset from JSON generated by fiftyone.core.collections.SampleCollection.write_json or fiftyone.core.collections.SampleCollection.to_json.
fiftyone.core.dataset.Dataset._add_view_stage

fiftyone.core.dataset.Dataset.html#_add_view_stage

Function

Method

PRIVATE

Returns a fiftyone.core.view.DatasetView containing the contents of the collection with the given fiftyone.core.stages.ViewStage` appended to its aggregation pipeline.
fiftyone.core.dataset.Dataset._pipeline

fiftyone.core.dataset.Dataset.html#_pipeline

Function

Method

PRIVATE

Returns the MongoDB aggregation pipeline for the collection.
fiftyone.core.dataset.Dataset._attach_frames_pipeline

fiftyone.core.dataset.Dataset.html#_attach_frames_pipeline

Function

Method

PRIVATE

A pipeline that attaches the frame documents for each document.
fiftyone.core.dataset.Dataset._unwind_frames_pipeline

fiftyone.core.dataset.Dataset.html#_unwind_frames_pipeline

Function

Method

PRIVATE

A pipeline that returns (only) the unwound frames documents.
fiftyone.core.dataset.Dataset._group_select_pipeline

fiftyone.core.dataset.Dataset.html#_group_select_pipeline

Function

Method

PRIVATE

A pipeline that selects only the given slice's documents from the pipeline.
fiftyone.core.dataset.Dataset._attach_groups_pipeline

fiftyone.core.dataset.Dataset.html#_attach_groups_pipeline

Function

Method

PRIVATE

A pipeline that attaches the requested group slice(s) for each document and stores them in under groups.<slice> keys.
fiftyone.core.dataset.Dataset._groups_only_pipeline

fiftyone.core.dataset.Dataset.html#_groups_only_pipeline

Function

Method

PRIVATE

A pipeline that looks up the requested group slices for each document and returns (only) the unwound group slices.
fiftyone.core.dataset.Dataset._unwind_groups_pipeline

fiftyone.core.dataset.Dataset.html#_unwind_groups_pipeline

Function

Method

PRIVATE

A pipeline that returns (only) the unwound groups documents.
fiftyone.core.dataset.Dataset._aggregate

fiftyone.core.dataset.Dataset.html#_aggregate

Function

Method

PRIVATE

Runs the MongoDB aggregation pipeline on the collection and returns the result.
fiftyone.core.dataset.Dataset._sample_collection_name

fiftyone.core.dataset.Dataset.html#_sample_collection_name

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._sample_collection

fiftyone.core.dataset.Dataset.html#_sample_collection

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._get_sample_collection

fiftyone.core.dataset.Dataset.html#_get_sample_collection

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._frame_collection_name

fiftyone.core.dataset.Dataset.html#_frame_collection_name

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._frame_collection

fiftyone.core.dataset.Dataset.html#_frame_collection

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._get_frame_collection

fiftyone.core.dataset.Dataset.html#_get_frame_collection

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._apply_sample_field_schema

fiftyone.core.dataset.Dataset.html#_apply_sample_field_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._apply_frame_field_schema

fiftyone.core.dataset.Dataset.html#_apply_frame_field_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._ensure_label_field

fiftyone.core.dataset.Dataset.html#_ensure_label_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._expand_schema

fiftyone.core.dataset.Dataset.html#_expand_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._expand_group_schema

fiftyone.core.dataset.Dataset.html#_expand_group_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._expand_frame_schema

fiftyone.core.dataset.Dataset.html#_expand_frame_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._make_sample

fiftyone.core.dataset.Dataset.html#_make_sample

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._sample_dict_to_doc

fiftyone.core.dataset.Dataset.html#_sample_dict_to_doc

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._make_frame

fiftyone.core.dataset.Dataset.html#_make_frame

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._frame_dict_to_doc

fiftyone.core.dataset.Dataset.html#_frame_dict_to_doc

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._validate_samples

fiftyone.core.dataset.Dataset.html#_validate_samples

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset.reload

fiftyone.core.dataset.Dataset.html#reload

Function

Method

PUBLIC

Reloads the dataset and any in-memory samples from the database.
fiftyone.core.dataset.Dataset.clear_cache

fiftyone.core.dataset.Dataset.html#clear_cache

Function

Method

PUBLIC

Clears the dataset's in-memory cache.
fiftyone.core.dataset.Dataset._reload

fiftyone.core.dataset.Dataset.html#_reload

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._reload_docs

fiftyone.core.dataset.Dataset.html#_reload_docs

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._serialize

fiftyone.core.dataset.Dataset.html#_serialize

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset.Dataset._update_last_loaded_at

fiftyone.core.dataset.Dataset.html#_update_last_loaded_at

Function

Method

PRIVATE

Undocumented
fiftyone.core.dataset._get_random_characters

fiftyone.core.dataset.html#_get_random_characters

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._list_datasets

fiftyone.core.dataset.html#_list_datasets

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._list_datasets_info

fiftyone.core.dataset.html#_list_datasets_info

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._list_datasets_query

fiftyone.core.dataset.html#_list_datasets_query

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._create_dataset

fiftyone.core.dataset.html#_create_dataset

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._create_indexes

fiftyone.core.dataset.html#_create_indexes

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._create_group_indexes

fiftyone.core.dataset.html#_create_group_indexes

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._clone_indexes

fiftyone.core.dataset.html#_clone_indexes

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._get_indexes_to_skip

fiftyone.core.dataset.html#_get_indexes_to_skip

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._clone_collection_indexes

fiftyone.core.dataset.html#_clone_collection_indexes

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._make_sample_collection_name

fiftyone.core.dataset.html#_make_sample_collection_name

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._make_frame_collection_name

fiftyone.core.dataset.html#_make_frame_collection_name

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._create_sample_document_cls

fiftyone.core.dataset.html#_create_sample_document_cls

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._create_frame_document_cls

fiftyone.core.dataset.html#_create_frame_document_cls

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._declare_fields

fiftyone.core.dataset.html#_declare_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._load_clips_source_dataset

fiftyone.core.dataset.html#_load_clips_source_dataset

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._load_dataset

fiftyone.core.dataset.html#_load_dataset

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._do_load_dataset

fiftyone.core.dataset.html#_do_load_dataset

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._delete_dataset_doc

fiftyone.core.dataset.html#_delete_dataset_doc

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._clone_collection

fiftyone.core.dataset.html#_clone_collection

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._get_samples_pipeline

fiftyone.core.dataset.html#_get_samples_pipeline

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._get_frames_pipeline

fiftyone.core.dataset.html#_get_frames_pipeline

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._save_view

fiftyone.core.dataset.html#_save_view

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._merge_dataset_doc

fiftyone.core.dataset.html#_merge_dataset_doc

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._update_no_overwrite

fiftyone.core.dataset.html#_update_no_overwrite

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._clone_extras

fiftyone.core.dataset.html#_clone_extras

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._clone_reference_doc

fiftyone.core.dataset.html#_clone_reference_doc

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._clone_run

fiftyone.core.dataset.html#_clone_run

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._ensure_index

fiftyone.core.dataset.html#_ensure_index

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._cleanup_index

fiftyone.core.dataset.html#_cleanup_index

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._cleanup_frame_index

fiftyone.core.dataset.html#_cleanup_frame_index

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._get_single_index_map

fiftyone.core.dataset.html#_get_single_index_map

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._get_collstats

fiftyone.core.dataset.html#_get_collstats

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._add_collection_with_new_ids

fiftyone.core.dataset.html#_add_collection_with_new_ids

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._merge_samples_python

fiftyone.core.dataset.html#_merge_samples_python

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._make_merge_samples_generator

fiftyone.core.dataset.html#_make_merge_samples_generator

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._merge_samples_pipeline

fiftyone.core.dataset.html#_merge_samples_pipeline

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._merge_docs

fiftyone.core.dataset.html#_merge_docs

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._merge_list_field

fiftyone.core.dataset.html#_merge_list_field

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._merge_label_list_field

fiftyone.core.dataset.html#_merge_label_list_field

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._index_frames

fiftyone.core.dataset.html#_index_frames

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._always_select_field

fiftyone.core.dataset.html#_always_select_field

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._finalize_frames

fiftyone.core.dataset.html#_finalize_frames

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._get_media_type

fiftyone.core.dataset.html#_get_media_type

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._get_group_field

fiftyone.core.dataset.html#_get_group_field

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._get_sample_ids

fiftyone.core.dataset.html#_get_sample_ids

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._get_frame_ids

fiftyone.core.dataset.html#_get_frame_ids

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._get_frame_ids_for_sample

fiftyone.core.dataset.html#_get_frame_ids_for_sample

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._get_group_ids

fiftyone.core.dataset.html#_get_group_ids

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._get_group_id

fiftyone.core.dataset.html#_get_group_id

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._to_list

fiftyone.core.dataset.html#_to_list

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._discard_none

fiftyone.core.dataset.html#_discard_none

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._parse_fields

fiftyone.core.dataset.html#_parse_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._parse_field_mapping

fiftyone.core.dataset.html#_parse_field_mapping

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._handle_nested_fields

fiftyone.core.dataset.html#_handle_nested_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._set_field_read_only

fiftyone.core.dataset.html#_set_field_read_only

Function

Function

PRIVATE

Undocumented
fiftyone.core.dataset._extract_archive_if_necessary

fiftyone.core.dataset.html#_extract_archive_if_necessary

Function

Function

PRIVATE

Undocumented
fiftyone.core.document._Document

fiftyone.core.document._Document.html

Class

Class

PRIVATE

No class docstring; 6/6 properties, 0/2 instance variable, 13/29 methods documented
fiftyone.core.document._Document.__init__

fiftyone.core.document._Document.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.document._Document._doc

fiftyone.core.document._Document.html#_doc

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.document._Document._dataset

fiftyone.core.document._Document.html#_dataset

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.document._Document.__str__

fiftyone.core.document._Document.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.document._Document.__repr__

fiftyone.core.document._Document.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.document._Document.__dir__

fiftyone.core.document._Document.html#__dir__

Function

Method

PUBLIC

Undocumented
fiftyone.core.document._Document.__eq__

fiftyone.core.document._Document.html#__eq__

Function

Method

PUBLIC

Undocumented
fiftyone.core.document._Document.__contains__

fiftyone.core.document._Document.html#__contains__

Function

Method

PUBLIC

Undocumented
fiftyone.core.document._Document.__getattr__

fiftyone.core.document._Document.html#__getattr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.document._Document.__setattr__

fiftyone.core.document._Document.html#__setattr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.document._Document.__delattr__

fiftyone.core.document._Document.html#__delattr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.document._Document.__getitem__

fiftyone.core.document._Document.html#__getitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.document._Document.__setitem__

fiftyone.core.document._Document.html#__setitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.document._Document.__delitem__

fiftyone.core.document._Document.html#__delitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.document._Document.__copy__

fiftyone.core.document._Document.html#__copy__

Function

Method

PUBLIC

Undocumented
fiftyone.core.document._Document._id

fiftyone.core.document._Document.html#_id

Attribute

Property

PRIVATE

The ObjectId of the document, or None if it has not been added to the database.
fiftyone.core.document._Document.in_dataset

fiftyone.core.document._Document.html#in_dataset

Attribute

Property

PUBLIC

Whether the document has been added to a dataset.
fiftyone.core.document._Document.dataset

fiftyone.core.document._Document.html#dataset

Attribute

Property

PUBLIC

The dataset to which this document belongs, or None if it has not been added to a dataset.
fiftyone.core.document._Document._collection

fiftyone.core.document._Document.html#_collection

Attribute

Property

PRIVATE

The fiftyone.core.collections.SampleCollection from which this document was taken, or None if it is not in a dataset.
fiftyone.core.document._Document.field_names

fiftyone.core.document._Document.html#field_names

Attribute

Property

PUBLIC

An ordered tuple of the public field names of this document.
fiftyone.core.document._Document._in_db

fiftyone.core.document._Document.html#_in_db

Attribute

Property

PRIVATE

Whether the document has been inserted into the database.
fiftyone.core.document._Document._get_field_names

fiftyone.core.document._Document.html#_get_field_names

Function

Method

PRIVATE

Returns an ordered tuple of field names of this document.
fiftyone.core.document._Document.has_field

fiftyone.core.document._Document.html#has_field

Function

Method

PUBLIC

Determines whether the document has the given field.
fiftyone.core.document._Document.get_field

fiftyone.core.document._Document.html#get_field

Function

Method

PUBLIC

Gets the value of a field of the document.
fiftyone.core.document._Document.set_field

fiftyone.core.document._Document.html#set_field

Function

Method

PUBLIC

Sets the value of a field of the document.
fiftyone.core.document._Document.update_fields

fiftyone.core.document._Document.html#update_fields

Function

Method

PUBLIC

Sets the dictionary of fields on the document.
fiftyone.core.document._Document.clear_field

fiftyone.core.document._Document.html#clear_field

Function

Method

PUBLIC

Clears the value of a field of the document.
fiftyone.core.document._Document.iter_fields

fiftyone.core.document._Document.html#iter_fields

Function

Method

PUBLIC

Returns an iterator over the (name, value) pairs of the public fields of the document.
fiftyone.core.document._Document._iter_label_fields

fiftyone.core.document._Document.html#_iter_label_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.document._Document.merge

fiftyone.core.document._Document.html#merge

Function

Method

PUBLIC

Merges the fields of the document into this document.
fiftyone.core.document._Document.copy

fiftyone.core.document._Document.html#copy

Function

Method

PUBLIC

Returns a deep copy of the document that has not been added to the database.
fiftyone.core.document._Document.to_dict

fiftyone.core.document._Document.html#to_dict

Function

Method

PUBLIC

Serializes the document to a JSON dictionary.
fiftyone.core.document._Document.to_mongo_dict

fiftyone.core.document._Document.html#to_mongo_dict

Function

Method

PUBLIC

Serializes the document to a BSON dictionary equivalent to the representation that would be stored in the database.
fiftyone.core.document._Document.to_json

fiftyone.core.document._Document.html#to_json

Function

Method

PUBLIC

Serializes the document to a JSON string.
fiftyone.core.document._Document.save

fiftyone.core.document._Document.html#save

Function

Method

PUBLIC

Saves the document to the database.
fiftyone.core.document._Document._save

fiftyone.core.document._Document.html#_save

Function

Method

PRIVATE

Undocumented
fiftyone.core.document._Document._parse_fields

fiftyone.core.document._Document.html#_parse_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.document.Document

fiftyone.core.document.Document.html

Class

Class

PUBLIC

Abstract base class for objects that are associated with fiftyone.core.dataset.Dataset instances and are backed by documents in database collections.
fiftyone.core.document.Document._NO_DATASET_DOC_CLS

fiftyone.core.document.Document.html#_NO_DATASET_DOC_CLS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.document.Document.__init__

fiftyone.core.document.Document.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.document.Document.copy

fiftyone.core.document.Document.html#copy

Function

Method

PUBLIC

Returns a deep copy of the document that has not been added to the database.
fiftyone.core.document.Document.reload

fiftyone.core.document.Document.html#reload

Function

Method

PUBLIC

Reloads the document from the database.
fiftyone.core.document.Document.from_doc

fiftyone.core.document.Document.html#from_doc

Function

Class Method

PUBLIC

Creates a document backed by the given database document.
fiftyone.core.document.Document.from_dict

fiftyone.core.document.Document.html#from_dict

Function

Class Method

PUBLIC

Loads the document from a JSON dictionary.
fiftyone.core.document.Document.from_json

fiftyone.core.document.Document.html#from_json

Function

Class Method

PUBLIC

Loads the document from a JSON string.
fiftyone.core.document.Document._reload_backing_doc

fiftyone.core.document.Document.html#_reload_backing_doc

Function

Method

PRIVATE

Reloads the backing doc from the database.
fiftyone.core.document.Document._set_backing_doc

fiftyone.core.document.Document.html#_set_backing_doc

Function

Method

PRIVATE

Sets the backing doc for the document.
fiftyone.core.document.Document._doc

fiftyone.core.document.Document.html#_doc

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.document.Document._dataset

fiftyone.core.document.Document.html#_dataset

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.document.Document._reset_backing_doc

fiftyone.core.document.Document.html#_reset_backing_doc

Function

Method

PRIVATE

Resets the backing doc for the document.
fiftyone.core.document.DocumentView

fiftyone.core.document.DocumentView.html

Class

Class

PUBLIC

A view into a Document in a dataset.
fiftyone.core.document.DocumentView.__init__

fiftyone.core.document.DocumentView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.document.DocumentView._view

fiftyone.core.document.DocumentView.html#_view

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.document.DocumentView._selected_fields

fiftyone.core.document.DocumentView.html#_selected_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.document.DocumentView._excluded_fields

fiftyone.core.document.DocumentView.html#_excluded_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.document.DocumentView._filtered_fields

fiftyone.core.document.DocumentView.html#_filtered_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.document.DocumentView.__repr__

fiftyone.core.document.DocumentView.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.document.DocumentView._collection

fiftyone.core.document.DocumentView.html#_collection

Attribute

Property

PRIVATE

The fiftyone.core.collections.SampleCollection from which this document was taken, or None if it is not in a dataset.
fiftyone.core.document.DocumentView.field_names

fiftyone.core.document.DocumentView.html#field_names

Attribute

Property

PUBLIC

An ordered tuple of field names of this document view.
fiftyone.core.document.DocumentView._get_field_names

fiftyone.core.document.DocumentView.html#_get_field_names

Function

Method

PRIVATE

Returns an ordered tuple of field names of this document.
fiftyone.core.document.DocumentView._to_db_fields

fiftyone.core.document.DocumentView.html#_to_db_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.document.DocumentView.selected_field_names

fiftyone.core.document.DocumentView.html#selected_field_names

Attribute

Property

PUBLIC

The set of field names that are selected on this document view, or None if no fields are explicitly selected.
fiftyone.core.document.DocumentView.excluded_field_names

fiftyone.core.document.DocumentView.html#excluded_field_names

Attribute

Property

PUBLIC

The set of field names that are excluded on this document view, or None if no fields are explicitly excluded.
fiftyone.core.document.DocumentView.filtered_field_names

fiftyone.core.document.DocumentView.html#filtered_field_names

Attribute

Property

PUBLIC

The set of field names or embedded.field.names that have been filtered on this document view, or None if no fields are filtered.
fiftyone.core.document.DocumentView.has_field

fiftyone.core.document.DocumentView.html#has_field

Function

Method

PUBLIC

Determines whether the document has the given field.
fiftyone.core.document.DocumentView.get_field

fiftyone.core.document.DocumentView.html#get_field

Function

Method

PUBLIC

Gets the value of a field of the document.
fiftyone.core.document.DocumentView.set_field

fiftyone.core.document.DocumentView.html#set_field

Function

Method

PUBLIC

Sets the value of a field of the document.
fiftyone.core.document.DocumentView.clear_field

fiftyone.core.document.DocumentView.html#clear_field

Function

Method

PUBLIC

Clears the value of a field of the document.
fiftyone.core.document.DocumentView.to_dict

fiftyone.core.document.DocumentView.html#to_dict

Function

Method

PUBLIC

Serializes the document to a JSON dictionary.
fiftyone.core.document.DocumentView.to_mongo_dict

fiftyone.core.document.DocumentView.html#to_mongo_dict

Function

Method

PUBLIC

Serializes the document to a BSON dictionary equivalent to the representation that would be stored in the database.
fiftyone.core.document.DocumentView.copy

fiftyone.core.document.DocumentView.html#copy

Function

Method

PUBLIC

Returns a deep copy of the document that has not been added to the database.
fiftyone.core.document.DocumentView.save

fiftyone.core.document.DocumentView.html#save

Function

Method

PUBLIC

Saves the document view to the database.
fiftyone.core.document.DocumentView._save

fiftyone.core.document.DocumentView.html#_save

Function

Method

PRIVATE

Undocumented
fiftyone.core.document.DocumentView._reload_parents

fiftyone.core.document.DocumentView.html#_reload_parents

Function

Method

PRIVATE

Undocumented
fiftyone.core.document._merge_lists

fiftyone.core.document.html#_merge_lists

Function

Function

PRIVATE

Undocumented
fiftyone.core.document._merge_labels

fiftyone.core.document.html#_merge_labels

Function

Function

PRIVATE

Undocumented
fiftyone.core.frame.fov

fiftyone.core.frame.html#fov

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.frame.get_default_frame_fields

fiftyone.core.frame.html#get_default_frame_fields

Function

Function

PUBLIC

Returns the default fields present on all frames.
fiftyone.core.frame.Frames

fiftyone.core.frame.Frames.html

Class

Class

PUBLIC

An ordered dictionary of Frame instances keyed by frame number representing the frames of a video fiftyone.core.sample.Sample.
fiftyone.core.frame.Frames.__init__

fiftyone.core.frame.Frames.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.frame.Frames._sample

fiftyone.core.frame.Frames.html#_sample

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.frame.Frames._iter

fiftyone.core.frame.Frames.html#_iter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.frame.Frames._replacements

fiftyone.core.frame.Frames.html#_replacements

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.frame.Frames._delete_frames

fiftyone.core.frame.Frames.html#_delete_frames

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.frame.Frames._delete_all

fiftyone.core.frame.Frames.html#_delete_all

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.frame.Frames.__str__

fiftyone.core.frame.Frames.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.frame.Frames.__repr__

fiftyone.core.frame.Frames.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.frame.Frames.__bool__

fiftyone.core.frame.Frames.html#__bool__

Function

Method

PUBLIC

Undocumented
fiftyone.core.frame.Frames.__len__

fiftyone.core.frame.Frames.html#__len__

Function

Method

PUBLIC

Undocumented
fiftyone.core.frame.Frames.__contains__

fiftyone.core.frame.Frames.html#__contains__

Function

Method

PUBLIC

Undocumented
fiftyone.core.frame.Frames.__getitem__

fiftyone.core.frame.Frames.html#__getitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.frame.Frames.__setitem__

fiftyone.core.frame.Frames.html#__setitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.frame.Frames.__delitem__

fiftyone.core.frame.Frames.html#__delitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.frame.Frames.__iter__

fiftyone.core.frame.Frames.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.core.frame.Frames.__next__

fiftyone.core.frame.Frames.html#__next__

Function

Method

PUBLIC

Undocumented
fiftyone.core.frame.Frames._in_db

fiftyone.core.frame.Frames.html#_in_db

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.frame.Frames._dataset

fiftyone.core.frame.Frames.html#_dataset

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.frame.Frames._sample_id

fiftyone.core.frame.Frames.html#_sample_id

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.frame.Frames._sample_collection

fiftyone.core.frame.Frames.html#_sample_collection

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.frame.Frames._frame_collection

fiftyone.core.frame.Frames.html#_frame_collection

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.frame.Frames._frame_collection_name

fiftyone.core.frame.Frames.html#_frame_collection_name

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.frame.Frames.field_names

fiftyone.core.frame.Frames.html#field_names

Attribute

Property

PUBLIC

An ordered tuple of the names of the fields on the frames.
fiftyone.core.frame.Frames.first

fiftyone.core.frame.Frames.html#first

Function

Method

PUBLIC

Returns the first Frame for the sample.
fiftyone.core.frame.Frames.last

fiftyone.core.frame.Frames.html#last

Function

Method

PUBLIC

Returns the last Frame for the sample.
fiftyone.core.frame.Frames.head

fiftyone.core.frame.Frames.html#head

Function

Method

PUBLIC

Returns a list of the first few frames for the sample.
fiftyone.core.frame.Frames.tail

fiftyone.core.frame.Frames.html#tail

Function

Method

PUBLIC

Returns a list of the last few frames for the sample.
fiftyone.core.frame.Frames.keys

fiftyone.core.frame.Frames.html#keys

Function

Method

PUBLIC

Returns an iterator over the frame numbers with labels in the sample.
fiftyone.core.frame.Frames.items

fiftyone.core.frame.Frames.html#items

Function

Method

PUBLIC

Returns an iterator over the frame numberes and Frame instances for the sample.
fiftyone.core.frame.Frames.values

fiftyone.core.frame.Frames.html#values

Function

Method

PUBLIC

Returns an iterator over the Frame instances for the sample.
fiftyone.core.frame.Frames.add_frame

fiftyone.core.frame.Frames.html#add_frame

Function

Method

PUBLIC

Adds the frame to this instance.
fiftyone.core.frame.Frames.delete_frame

fiftyone.core.frame.Frames.html#delete_frame

Function

Method

PUBLIC

Deletes the given frame number from this instance.
fiftyone.core.frame.Frames.update

fiftyone.core.frame.Frames.html#update

Function

Method

PUBLIC

Adds the frame labels to this instance.
fiftyone.core.frame.Frames.merge

fiftyone.core.frame.Frames.html#merge

Function

Method

PUBLIC

Merges the given frames into this instance.
fiftyone.core.frame.Frames.clear

fiftyone.core.frame.Frames.html#clear

Function

Method

PUBLIC

Removes all frames from this sample.
fiftyone.core.frame.Frames.save

fiftyone.core.frame.Frames.html#save

Function

Method

PUBLIC

Saves all frames for the sample to the database.
fiftyone.core.frame.Frames._save

fiftyone.core.frame.Frames.html#_save

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.Frames.reload

fiftyone.core.frame.Frames.html#reload

Function

Method

PUBLIC

Reloads all frames for the sample from the database.
fiftyone.core.frame.Frames._get_frame_numbers

fiftyone.core.frame.Frames.html#_get_frame_numbers

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.Frames._get_frame_db

fiftyone.core.frame.Frames.html#_get_frame_db

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.Frames._get_frames_match_stage

fiftyone.core.frame.Frames.html#_get_frames_match_stage

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.Frames._get_frame_numbers_db

fiftyone.core.frame.Frames.html#_get_frame_numbers_db

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.Frames._get_ids_map

fiftyone.core.frame.Frames.html#_get_ids_map

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.Frames._set_replacement

fiftyone.core.frame.Frames.html#_set_replacement

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.Frames._iter_frames

fiftyone.core.frame.Frames.html#_iter_frames

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.Frames._iter_frames_db

fiftyone.core.frame.Frames.html#_iter_frames_db

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.Frames._make_frame

fiftyone.core.frame.Frames.html#_make_frame

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.Frames._make_dict

fiftyone.core.frame.Frames.html#_make_dict

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.Frames._to_frames_dict

fiftyone.core.frame.Frames.html#_to_frames_dict

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.Frames._save_deletions

fiftyone.core.frame.Frames.html#_save_deletions

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.Frames._save_replacements

fiftyone.core.frame.Frames.html#_save_replacements

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.Frames._validate_frame

fiftyone.core.frame.Frames.html#_validate_frame

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.FramesView

fiftyone.core.frame.FramesView.html

Class

Class

PUBLIC

An ordered dictionary of FrameView instances keyed by frame number representing the frames of a video fiftyone.core.sample.SampleView.
fiftyone.core.frame.FramesView.__init__

fiftyone.core.frame.FramesView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.frame.FramesView._view

fiftyone.core.frame.FramesView.html#_view

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.frame.FramesView._filtered_fields

fiftyone.core.frame.FramesView.html#_filtered_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.frame.FramesView._needs_frames

fiftyone.core.frame.FramesView.html#_needs_frames

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.frame.FramesView._frames_pipeline

fiftyone.core.frame.FramesView.html#_frames_pipeline

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.frame.FramesView.field_names

fiftyone.core.frame.FramesView.html#field_names

Attribute

Property

PUBLIC

An ordered tuple of the names of the fields on the frames.
fiftyone.core.frame.FramesView.add_frame

fiftyone.core.frame.FramesView.html#add_frame

Function

Method

PUBLIC

Adds the frame to this instance.
fiftyone.core.frame.FramesView.reload

fiftyone.core.frame.FramesView.html#reload

Function

Method

PUBLIC

Reloads the view into the frames of the attached sample.
fiftyone.core.frame.FramesView._delete_all

fiftyone.core.frame.FramesView.html#_delete_all

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.frame.FramesView._get_frame_numbers_db

fiftyone.core.frame.FramesView.html#_get_frame_numbers_db

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.FramesView._get_frame_db

fiftyone.core.frame.FramesView.html#_get_frame_db

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.FramesView._iter_frames_db

fiftyone.core.frame.FramesView.html#_iter_frames_db

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.FramesView._make_frame

fiftyone.core.frame.FramesView.html#_make_frame

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.FramesView._save_replacements

fiftyone.core.frame.FramesView.html#_save_replacements

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.FramesView.save

fiftyone.core.frame.FramesView.html#save

Function

Method

PUBLIC

Saves all frames for the sample to the database.
fiftyone.core.frame.FramesView._reload_parents

fiftyone.core.frame.FramesView.html#_reload_parents

Function

Method

PRIVATE

Undocumented
fiftyone.core.frame.Frame

fiftyone.core.frame.Frame.html

Class

Class

PUBLIC

A frame in a video fiftyone.core.sample.Sample.
fiftyone.core.frame.Frame.dataset_id

fiftyone.core.frame.Frame.html#dataset_id

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.frame.Frame._dataset_id

fiftyone.core.frame.Frame.html#_dataset_id

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.frame.Frame.sample_id

fiftyone.core.frame.Frame.html#sample_id

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.frame.Frame._sample_id

fiftyone.core.frame.Frame.html#_sample_id

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.frame.Frame.save

fiftyone.core.frame.Frame.html#save

Function

Method

PUBLIC

Saves the frame to the database.
fiftyone.core.frame.Frame._reload_backing_doc

fiftyone.core.frame.Frame.html#_reload_backing_doc

Function

Method

PRIVATE

Reloads the backing doc from the database.
fiftyone.core.frame.Frame._doc

fiftyone.core.frame.Frame.html#_doc

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.frame.FrameView

fiftyone.core.frame.FrameView.html

Class

Class

PUBLIC

A view into a Frame in a video dataset.
fiftyone.core.frame.FrameView.dataset_id

fiftyone.core.frame.FrameView.html#dataset_id

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.frame.FrameView._dataset_id

fiftyone.core.frame.FrameView.html#_dataset_id

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.frame.FrameView.sample_id

fiftyone.core.frame.FrameView.html#sample_id

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.frame.FrameView._sample_id

fiftyone.core.frame.FrameView.html#_sample_id

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.groups.Group

fiftyone.core.groups.Group.html

Class

Class

PUBLIC

A named group membership.
fiftyone.core.groups.Group.id

fiftyone.core.groups.Group.html#id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.groups.Group.name

fiftyone.core.groups.Group.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.groups.Group.__deepcopy__

fiftyone.core.groups.Group.html#__deepcopy__

Function

Method

PUBLIC

Undocumented
fiftyone.core.groups.Group._id

fiftyone.core.groups.Group.html#_id

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.groups.Group.element

fiftyone.core.groups.Group.html#element

Function

Method

PUBLIC

Undocumented
fiftyone.core.groups.is_group_field

fiftyone.core.groups.html#is_group_field

Function

Function

PUBLIC

Determines whether the given field is a group field.
fiftyone.core.odm.mixins.fod

fiftyone.core.odm.mixins.html#fod

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.odm.mixins.fog

fiftyone.core.odm.mixins.html#fog

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.odm.mixins.get_default_fields

fiftyone.core.odm.mixins.html#get_default_fields

Function

Function

PUBLIC

Gets the default fields present on all instances of the given DatasetMixin class.
fiftyone.core.odm.mixins.DatasetMixin

fiftyone.core.odm.mixins.DatasetMixin.html

Class

Class

PUBLIC

Mixin interface for fiftyone.core.odm.document.Document subclasses that are backed by a dataset.
fiftyone.core.odm.mixins.DatasetMixin._is_frames_doc

fiftyone.core.odm.mixins.DatasetMixin.html#_is_frames_doc

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._dataset

fiftyone.core.odm.mixins.DatasetMixin.html#_dataset

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin.__setattr__

fiftyone.core.odm.mixins.DatasetMixin.html#__setattr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.mixins.DatasetMixin.collection_name

fiftyone.core.odm.mixins.DatasetMixin.html#collection_name

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.odm.mixins.DatasetMixin.field_names

fiftyone.core.odm.mixins.DatasetMixin.html#field_names

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._doc_name

fiftyone.core.odm.mixins.DatasetMixin.html#_doc_name

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._fields_attr

fiftyone.core.odm.mixins.DatasetMixin.html#_fields_attr

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._get_field_names

fiftyone.core.odm.mixins.DatasetMixin.html#_get_field_names

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._get_default_fields

fiftyone.core.odm.mixins.DatasetMixin.html#_get_default_fields

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._get_fields_ordered

fiftyone.core.odm.mixins.DatasetMixin.html#_get_fields_ordered

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._to_db_fields

fiftyone.core.odm.mixins.DatasetMixin.html#_to_db_fields

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin.get_field

fiftyone.core.odm.mixins.DatasetMixin.html#get_field

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.mixins.DatasetMixin.set_field

fiftyone.core.odm.mixins.DatasetMixin.html#set_field

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.mixins.DatasetMixin.clear_field

fiftyone.core.odm.mixins.DatasetMixin.html#clear_field

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.mixins.DatasetMixin.get_field_schema

fiftyone.core.odm.mixins.DatasetMixin.html#get_field_schema

Function

Class Method

PUBLIC

Returns a schema dictionary describing the fields of this document.
fiftyone.core.odm.mixins.DatasetMixin.merge_field_schema

fiftyone.core.odm.mixins.DatasetMixin.html#merge_field_schema

Function

Class Method

PUBLIC

Merges the field schema into this document.
fiftyone.core.odm.mixins.DatasetMixin.add_field

fiftyone.core.odm.mixins.DatasetMixin.html#add_field

Function

Class Method

PUBLIC

Adds a new field or embedded field to the document, if necessary.
fiftyone.core.odm.mixins.DatasetMixin.add_implied_field

fiftyone.core.odm.mixins.DatasetMixin.html#add_implied_field

Function

Class Method

PUBLIC

Adds the field or embedded field to the document, if necessary, inferring the field type from the provided value.
fiftyone.core.odm.mixins.DatasetMixin._create_field

fiftyone.core.odm.mixins.DatasetMixin.html#_create_field

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._rename_fields

fiftyone.core.odm.mixins.DatasetMixin.html#_rename_fields

Function

Class Method

PRIVATE

Renames the fields of the documents in this collection.
fiftyone.core.odm.mixins.DatasetMixin._clone_fields

fiftyone.core.odm.mixins.DatasetMixin.html#_clone_fields

Function

Class Method

PRIVATE

Clones the field(s) of the documents in this collection.
fiftyone.core.odm.mixins.DatasetMixin._clear_fields

fiftyone.core.odm.mixins.DatasetMixin.html#_clear_fields

Function

Class Method

PRIVATE

Clears the field(s) of the documents in this collection.
fiftyone.core.odm.mixins.DatasetMixin._delete_fields

fiftyone.core.odm.mixins.DatasetMixin.html#_delete_fields

Function

Class Method

PRIVATE

Deletes the field(s) from the documents in this collection.
fiftyone.core.odm.mixins.DatasetMixin._remove_dynamic_fields

fiftyone.core.odm.mixins.DatasetMixin.html#_remove_dynamic_fields

Function

Class Method

PRIVATE

Removes the dynamic embedded field(s) from the collection's schema.
fiftyone.core.odm.mixins.DatasetMixin._rename_fields_simple

fiftyone.core.odm.mixins.DatasetMixin.html#_rename_fields_simple

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._rename_fields_collection

fiftyone.core.odm.mixins.DatasetMixin.html#_rename_fields_collection

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._clone_fields_simple

fiftyone.core.odm.mixins.DatasetMixin.html#_clone_fields_simple

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._clone_fields_collection

fiftyone.core.odm.mixins.DatasetMixin.html#_clone_fields_collection

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._clear_fields_simple

fiftyone.core.odm.mixins.DatasetMixin.html#_clear_fields_simple

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._clear_fields_collection

fiftyone.core.odm.mixins.DatasetMixin.html#_clear_fields_collection

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._delete_fields_simple

fiftyone.core.odm.mixins.DatasetMixin.html#_delete_fields_simple

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._handle_db_field

fiftyone.core.odm.mixins.DatasetMixin.html#_handle_db_field

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._handle_db_fields

fiftyone.core.odm.mixins.DatasetMixin.html#_handle_db_fields

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._merge_field

fiftyone.core.odm.mixins.DatasetMixin.html#_merge_field

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._add_field_schema

fiftyone.core.odm.mixins.DatasetMixin.html#_add_field_schema

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._rename_field_schema

fiftyone.core.odm.mixins.DatasetMixin.html#_rename_field_schema

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._clone_field_schema

fiftyone.core.odm.mixins.DatasetMixin.html#_clone_field_schema

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._delete_field_schema

fiftyone.core.odm.mixins.DatasetMixin.html#_delete_field_schema

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._rename_indexes

fiftyone.core.odm.mixins.DatasetMixin.html#_rename_indexes

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._delete_indexes

fiftyone.core.odm.mixins.DatasetMixin.html#_delete_indexes

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._update_field_metadata

fiftyone.core.odm.mixins.DatasetMixin.html#_update_field_metadata

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._reload_fields

fiftyone.core.odm.mixins.DatasetMixin.html#_reload_fields

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._get_field

fiftyone.core.odm.mixins.DatasetMixin.html#_get_field

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._get_field_doc

fiftyone.core.odm.mixins.DatasetMixin.html#_get_field_doc

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._parse_path

fiftyone.core.odm.mixins.DatasetMixin.html#_parse_path

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._declare_field

fiftyone.core.odm.mixins.DatasetMixin.html#_declare_field

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._update_field

fiftyone.core.odm.mixins.DatasetMixin.html#_update_field

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._undeclare_field

fiftyone.core.odm.mixins.DatasetMixin.html#_undeclare_field

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._insert

fiftyone.core.odm.mixins.DatasetMixin.html#_insert

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin.created_at

fiftyone.core.odm.mixins.DatasetMixin.html#created_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.mixins.DatasetMixin.last_modified_at

fiftyone.core.odm.mixins.DatasetMixin.html#last_modified_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._update

fiftyone.core.odm.mixins.DatasetMixin.html#_update

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._do_updates

fiftyone.core.odm.mixins.DatasetMixin.html#_do_updates

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._deferred_updates

fiftyone.core.odm.mixins.DatasetMixin.html#_deferred_updates

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.DatasetMixin._extract_extra_updates

fiftyone.core.odm.mixins.DatasetMixin.html#_extract_extra_updates

Function

Method

PRIVATE

Extracts updates for filtered list fields that need to be updated by ID, not relative position (index).
fiftyone.core.odm.mixins.DatasetMixin._parse_id_and_array_filter

fiftyone.core.odm.mixins.DatasetMixin.html#_parse_id_and_array_filter

Function

Method

PRIVATE

Converts the list_element_field and filtered_field to an element object ID and array filter.
fiftyone.core.odm.mixins.NoDatasetMixin

fiftyone.core.odm.mixins.NoDatasetMixin.html

Class

Class

PUBLIC

Mixin for fiftyone.core.odm.document.SerializableDocument subtypes that are not backed by a dataset.
fiftyone.core.odm.mixins.NoDatasetMixin._is_frames_doc

fiftyone.core.odm.mixins.NoDatasetMixin.html#_is_frames_doc

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin.__getattr__

fiftyone.core.odm.mixins.NoDatasetMixin.html#__getattr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin.__setattr__

fiftyone.core.odm.mixins.NoDatasetMixin.html#__setattr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin._get_field_names

fiftyone.core.odm.mixins.NoDatasetMixin.html#_get_field_names

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin._to_db_fields

fiftyone.core.odm.mixins.NoDatasetMixin.html#_to_db_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin._get_repr_fields

fiftyone.core.odm.mixins.NoDatasetMixin.html#_get_repr_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin._doc_name

fiftyone.core.odm.mixins.NoDatasetMixin.html#_doc_name

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin.field_names

fiftyone.core.odm.mixins.NoDatasetMixin.html#field_names

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin.in_db

fiftyone.core.odm.mixins.NoDatasetMixin.html#in_db

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin._get_default

fiftyone.core.odm.mixins.NoDatasetMixin.html#_get_default

Function

Static Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin.has_field

fiftyone.core.odm.mixins.NoDatasetMixin.html#has_field

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin.get_field

fiftyone.core.odm.mixins.NoDatasetMixin.html#get_field

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin.set_field

fiftyone.core.odm.mixins.NoDatasetMixin.html#set_field

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin.clear_field

fiftyone.core.odm.mixins.NoDatasetMixin.html#clear_field

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin.to_dict

fiftyone.core.odm.mixins.NoDatasetMixin.html#to_dict

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin.from_dict

fiftyone.core.odm.mixins.NoDatasetMixin.html#from_dict

Function

Class Method

PUBLIC

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin.save

fiftyone.core.odm.mixins.NoDatasetMixin.html#save

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin._save

fiftyone.core.odm.mixins.NoDatasetMixin.html#_save

Function

Method

PRIVATE

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin.reload

fiftyone.core.odm.mixins.NoDatasetMixin.html#reload

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.mixins.NoDatasetMixin.delete

fiftyone.core.odm.mixins.NoDatasetMixin.html#delete

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.mixins._get_db_field

fiftyone.core.odm.mixins.html#_get_db_field

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.mixins._parse_paths

fiftyone.core.odm.mixins.html#_parse_paths

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.mixins._split_path

fiftyone.core.odm.mixins.html#_split_path

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.mixins._remove_nested_paths

fiftyone.core.odm.mixins.html#_remove_nested_paths

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.mixins._add_field_doc

fiftyone.core.odm.mixins.html#_add_field_doc

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.mixins._update_field_doc

fiftyone.core.odm.mixins.html#_update_field_doc

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.mixins._delete_field_doc

fiftyone.core.odm.mixins.html#_delete_field_doc

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.mixins._get_index_updates

fiftyone.core.odm.mixins.html#_get_index_updates

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.frame.DatasetFrameDocument

fiftyone.core.odm.frame.DatasetFrameDocument.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.odm.frame.DatasetFrameDocument.meta

fiftyone.core.odm.frame.DatasetFrameDocument.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.frame.DatasetFrameDocument._is_frames_doc

fiftyone.core.odm.frame.DatasetFrameDocument.html#_is_frames_doc

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.odm.frame.DatasetFrameDocument.id

fiftyone.core.odm.frame.DatasetFrameDocument.html#id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.frame.DatasetFrameDocument.frame_number

fiftyone.core.odm.frame.DatasetFrameDocument.html#frame_number

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.frame.DatasetFrameDocument.created_at

fiftyone.core.odm.frame.DatasetFrameDocument.html#created_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.frame.DatasetFrameDocument.last_modified_at

fiftyone.core.odm.frame.DatasetFrameDocument.html#last_modified_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.frame.DatasetFrameDocument._sample_id

fiftyone.core.odm.frame.DatasetFrameDocument.html#_sample_id

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.odm.frame.DatasetFrameDocument._dataset_id

fiftyone.core.odm.frame.DatasetFrameDocument.html#_dataset_id

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.odm.frame.NoDatasetFrameDocument

fiftyone.core.odm.frame.NoDatasetFrameDocument.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.odm.frame.NoDatasetFrameDocument._is_frames_doc

fiftyone.core.odm.frame.NoDatasetFrameDocument.html#_is_frames_doc

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.odm.frame.NoDatasetFrameDocument.default_fields_ordered

fiftyone.core.odm.frame.NoDatasetFrameDocument.html#default_fields_ordered

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.frame.NoDatasetFrameDocument.__init__

fiftyone.core.odm.frame.NoDatasetFrameDocument.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.frame.NoDatasetFrameDocument._data

fiftyone.core.odm.frame.NoDatasetFrameDocument.html#_data

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.odm.sample._random

fiftyone.core.odm.sample.html#_random

Attribute

Variable

PRIVATE

Undocumented
fiftyone.core.odm.sample._generate_rand

fiftyone.core.odm.sample.html#_generate_rand

Function

Function

PRIVATE

Undocumented
fiftyone.core.odm.sample.DatasetSampleDocument

fiftyone.core.odm.sample.DatasetSampleDocument.html

Class

Class

PUBLIC

Base class for sample documents backing samples in datasets.
fiftyone.core.odm.sample.DatasetSampleDocument.meta

fiftyone.core.odm.sample.DatasetSampleDocument.html#meta

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.sample.DatasetSampleDocument._is_frames_doc

fiftyone.core.odm.sample.DatasetSampleDocument.html#_is_frames_doc

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.odm.sample.DatasetSampleDocument.id

fiftyone.core.odm.sample.DatasetSampleDocument.html#id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.sample.DatasetSampleDocument.filepath

fiftyone.core.odm.sample.DatasetSampleDocument.html#filepath

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.sample.DatasetSampleDocument.tags

fiftyone.core.odm.sample.DatasetSampleDocument.html#tags

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.sample.DatasetSampleDocument.metadata

fiftyone.core.odm.sample.DatasetSampleDocument.html#metadata

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.sample.DatasetSampleDocument.created_at

fiftyone.core.odm.sample.DatasetSampleDocument.html#created_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.sample.DatasetSampleDocument.last_modified_at

fiftyone.core.odm.sample.DatasetSampleDocument.html#last_modified_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.odm.sample.DatasetSampleDocument._media_type

fiftyone.core.odm.sample.DatasetSampleDocument.html#_media_type

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.odm.sample.DatasetSampleDocument._rand

fiftyone.core.odm.sample.DatasetSampleDocument.html#_rand

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.odm.sample.DatasetSampleDocument._dataset_id

fiftyone.core.odm.sample.DatasetSampleDocument.html#_dataset_id

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.odm.sample.DatasetSampleDocument.media_type

fiftyone.core.odm.sample.DatasetSampleDocument.html#media_type

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.odm.sample.DatasetSampleDocument._get_repr_fields

fiftyone.core.odm.sample.DatasetSampleDocument.html#_get_repr_fields

Function

Method

PRIVATE

Returns an ordered tuple of field names that should be included in the repr of the document.
fiftyone.core.odm.sample.NoDatasetSampleDocument

fiftyone.core.odm.sample.NoDatasetSampleDocument.html

Class

Class

PUBLIC

Backing document for samples that have not been added to a dataset.
fiftyone.core.odm.sample.NoDatasetSampleDocument._is_frames_doc

fiftyone.core.odm.sample.NoDatasetSampleDocument.html#_is_frames_doc

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.odm.sample.NoDatasetSampleDocument.default_fields_ordered

fiftyone.core.odm.sample.NoDatasetSampleDocument.html#default_fields_ordered

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.odm.sample.NoDatasetSampleDocument.__init__

fiftyone.core.odm.sample.NoDatasetSampleDocument.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.odm.sample.NoDatasetSampleDocument._data

fiftyone.core.odm.sample.NoDatasetSampleDocument.html#_data

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.odm.sample.NoDatasetSampleDocument.media_type

fiftyone.core.odm.sample.NoDatasetSampleDocument.html#media_type

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.odm.sample.NoDatasetSampleDocument._get_repr_fields

fiftyone.core.odm.sample.NoDatasetSampleDocument.html#_get_repr_fields

Function

Method

PRIVATE

Returns an ordered tuple of field names that should be included in the repr of the document.
fiftyone.core.labels.foue

fiftyone.core.labels.html#foue

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.labels.foug

fiftyone.core.labels.html#foug

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.labels.foui

fiftyone.core.labels.html#foui

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.labels.sg

fiftyone.core.labels.html#sg

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.labels._NoDefault

fiftyone.core.labels._NoDefault.html

Class

Class

PRIVATE

Undocumented
fiftyone.core.labels.no_default

fiftyone.core.labels.html#no_default

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.labels._HasMedia

fiftyone.core.labels._HasMedia.html

Class

Class

PRIVATE

Mixin for Label classes that contain a media field.
fiftyone.core.labels._HasMedia._MEDIA_FIELD

fiftyone.core.labels._HasMedia.html#_MEDIA_FIELD

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.labels.Label

fiftyone.core.labels.Label.html

Class

Class

PUBLIC

Base class for labels.
fiftyone.core.labels.Label.iter_attributes

fiftyone.core.labels.Label.html#iter_attributes

Function

Method

PUBLIC

Returns an iterator over the custom attributes of the label.
fiftyone.core.labels.Label.has_attribute

fiftyone.core.labels.Label.html#has_attribute

Function

Method

PUBLIC

Determines whether the label has an attribute with the given name.
fiftyone.core.labels.Label.get_attribute_value

fiftyone.core.labels.Label.html#get_attribute_value

Function

Method

PUBLIC

Gets the value of the attribute with the given name.
fiftyone.core.labels.Label.set_attribute_value

fiftyone.core.labels.Label.html#set_attribute_value

Function

Method

PUBLIC

Sets the value of the attribute with the given name.
fiftyone.core.labels.Label.delete_attribute

fiftyone.core.labels.Label.html#delete_attribute

Function

Method

PUBLIC

Deletes the attribute with the given name.
fiftyone.core.labels.Attribute

fiftyone.core.labels.Attribute.html

Class

Class

PUBLIC

Base class for attributes.
fiftyone.core.labels.Attribute.value

fiftyone.core.labels.Attribute.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.BooleanAttribute

fiftyone.core.labels.BooleanAttribute.html

Class

Class

PUBLIC

A boolean attribute.
fiftyone.core.labels.BooleanAttribute.value

fiftyone.core.labels.BooleanAttribute.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.CategoricalAttribute

fiftyone.core.labels.CategoricalAttribute.html

Class

Class

PUBLIC

A categorical attribute.
fiftyone.core.labels.CategoricalAttribute.value

fiftyone.core.labels.CategoricalAttribute.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.CategoricalAttribute.confidence

fiftyone.core.labels.CategoricalAttribute.html#confidence

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.CategoricalAttribute.logits

fiftyone.core.labels.CategoricalAttribute.html#logits

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.NumericAttribute

fiftyone.core.labels.NumericAttribute.html

Class

Class

PUBLIC

A numeric attribute.
fiftyone.core.labels.NumericAttribute.value

fiftyone.core.labels.NumericAttribute.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.ListAttribute

fiftyone.core.labels.ListAttribute.html

Class

Class

PUBLIC

A list attribute.
fiftyone.core.labels.ListAttribute.value

fiftyone.core.labels.ListAttribute.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels._HasAttributesDict

fiftyone.core.labels._HasAttributesDict.html

Class

Class

PRIVATE

Mixin for Label classes that have an attributes field that contains a dict of Attribute instances.
fiftyone.core.labels._HasAttributesDict.attributes

fiftyone.core.labels._HasAttributesDict.html#attributes

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels._HasAttributesDict.iter_attributes

fiftyone.core.labels._HasAttributesDict.html#iter_attributes

Function

Method

PUBLIC

Returns an iterator over the custom attributes of the label.
fiftyone.core.labels._HasAttributesDict.has_attribute

fiftyone.core.labels._HasAttributesDict.html#has_attribute

Function

Method

PUBLIC

Determines whether the label has an attribute with the given name.
fiftyone.core.labels._HasAttributesDict.get_attribute_value

fiftyone.core.labels._HasAttributesDict.html#get_attribute_value

Function

Method

PUBLIC

Gets the value of the attribute with the given name.
fiftyone.core.labels._HasAttributesDict.set_attribute_value

fiftyone.core.labels._HasAttributesDict.html#set_attribute_value

Function

Method

PUBLIC

Sets the value of the attribute with the given name.
fiftyone.core.labels._HasAttributesDict.delete_attribute

fiftyone.core.labels._HasAttributesDict.html#delete_attribute

Function

Method

PUBLIC

Deletes the attribute with the given name.
fiftyone.core.labels._HasID

fiftyone.core.labels._HasID.html

Class

Class

PRIVATE

Mixin for Label classes that expose a UUID via an id property, as well as a tags attribute.
fiftyone.core.labels._HasID.id

fiftyone.core.labels._HasID.html#id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.labels._HasID.tags

fiftyone.core.labels._HasID.html#tags

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels._HasID._id

fiftyone.core.labels._HasID.html#_id

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.labels._HasID._id.setter

fiftyone.core.labels._HasID.html#_id.setter

Function

Method

PRIVATE

Undocumented
fiftyone.core.labels._HasLabelList

fiftyone.core.labels._HasLabelList.html

Class

Class

PRIVATE

Mixin for Label classes that contain a list of Label instances.
fiftyone.core.labels._HasLabelList._LABEL_LIST_FIELD

fiftyone.core.labels._HasLabelList.html#_LABEL_LIST_FIELD

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.labels.Regression

fiftyone.core.labels.Regression.html

Class

Class

PUBLIC

A regression value.
fiftyone.core.labels.Regression.value

fiftyone.core.labels.Regression.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Regression.confidence

fiftyone.core.labels.Regression.html#confidence

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Classification

fiftyone.core.labels.Classification.html

Class

Class

PUBLIC

A classification label.
fiftyone.core.labels.Classification.label

fiftyone.core.labels.Classification.html#label

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Classification.confidence

fiftyone.core.labels.Classification.html#confidence

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Classification.logits

fiftyone.core.labels.Classification.html#logits

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Classifications

fiftyone.core.labels.Classifications.html

Class

Class

PUBLIC

A list of classifications for an image.
fiftyone.core.labels.Classifications.classifications

fiftyone.core.labels.Classifications.html#classifications

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Classifications.logits

fiftyone.core.labels.Classifications.html#logits

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Classifications._LABEL_LIST_FIELD

fiftyone.core.labels.Classifications.html#_LABEL_LIST_FIELD

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.labels.Detection

fiftyone.core.labels.Detection.html

Class

Class

PUBLIC

An object detection.
fiftyone.core.labels.Detection.label

fiftyone.core.labels.Detection.html#label

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Detection.bounding_box

fiftyone.core.labels.Detection.html#bounding_box

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Detection.mask

fiftyone.core.labels.Detection.html#mask

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.labels.Detection.mask_path

fiftyone.core.labels.Detection.html#mask_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.labels.Detection.confidence

fiftyone.core.labels.Detection.html#confidence

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Detection.index

fiftyone.core.labels.Detection.html#index

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Detection._MEDIA_FIELD

fiftyone.core.labels.Detection.html#_MEDIA_FIELD

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.labels.Detection.has_mask

fiftyone.core.labels.Detection.html#has_mask

Attribute

Property

PUBLIC

Whether this instance has a mask.
fiftyone.core.labels.Detection.get_mask

fiftyone.core.labels.Detection.html#get_mask

Function

Method

PUBLIC

Returns the detection mask for this instance.
fiftyone.core.labels.Detection.import_mask

fiftyone.core.labels.Detection.html#import_mask

Function

Method

PUBLIC

Imports this instance's mask from disk to its mask attribute.
fiftyone.core.labels.Detection.export_mask

fiftyone.core.labels.Detection.html#export_mask

Function

Method

PUBLIC

Exports this instance's mask to the given path.
fiftyone.core.labels.Detection.to_polyline

fiftyone.core.labels.Detection.html#to_polyline

Function

Method

PUBLIC

Returns a Polyline representation of this instance.
fiftyone.core.labels.Detection.to_segmentation

fiftyone.core.labels.Detection.html#to_segmentation

Function

Method

PUBLIC

Returns a Segmentation representation of this instance.
fiftyone.core.labels.Detection.to_shapely

fiftyone.core.labels.Detection.html#to_shapely

Function

Method

PUBLIC

Returns a Shapely representation of this instance.
fiftyone.core.labels.Detection.from_mask

fiftyone.core.labels.Detection.html#from_mask

Function

Class Method

PUBLIC

Creates a Detection instance with its mask attribute populated from the given full image mask.
fiftyone.core.labels.Detections

fiftyone.core.labels.Detections.html

Class

Class

PUBLIC

A list of object detections in an image.
fiftyone.core.labels.Detections.detections

fiftyone.core.labels.Detections.html#detections

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Detections._LABEL_LIST_FIELD

fiftyone.core.labels.Detections.html#_LABEL_LIST_FIELD

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.labels.Detections.to_polylines

fiftyone.core.labels.Detections.html#to_polylines

Function

Method

PUBLIC

Returns a Polylines representation of this instance.
fiftyone.core.labels.Detections.to_segmentation

fiftyone.core.labels.Detections.html#to_segmentation

Function

Method

PUBLIC

Returns a Segmentation representation of this instance.
fiftyone.core.labels.Polyline

fiftyone.core.labels.Polyline.html

Class

Class

PUBLIC

A set of semantically related polylines or polygons.
fiftyone.core.labels.Polyline.label

fiftyone.core.labels.Polyline.html#label

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Polyline.points

fiftyone.core.labels.Polyline.html#points

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Polyline.confidence

fiftyone.core.labels.Polyline.html#confidence

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Polyline.index

fiftyone.core.labels.Polyline.html#index

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Polyline.closed

fiftyone.core.labels.Polyline.html#closed

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Polyline.filled

fiftyone.core.labels.Polyline.html#filled

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Polyline.to_detection

fiftyone.core.labels.Polyline.html#to_detection

Function

Method

PUBLIC

Returns a Detection representation of this instance whose bounding box tightly encloses the polyline.
fiftyone.core.labels.Polyline.to_segmentation

fiftyone.core.labels.Polyline.html#to_segmentation

Function

Method

PUBLIC

Returns a Segmentation representation of this instance.
fiftyone.core.labels.Polyline.to_shapely

fiftyone.core.labels.Polyline.html#to_shapely

Function

Method

PUBLIC

Returns a Shapely representation of this instance.
fiftyone.core.labels.Polyline.from_mask

fiftyone.core.labels.Polyline.html#from_mask

Function

Class Method

PUBLIC

Creates a Polyline instance with polygons describing the non-zero region(s) of the given full image mask.
fiftyone.core.labels.Polyline.from_cuboid

fiftyone.core.labels.Polyline.html#from_cuboid

Function

Class Method

PUBLIC

Constructs a cuboid from its 8 vertices in the format below:
fiftyone.core.labels.Polyline.from_rotated_box

fiftyone.core.labels.Polyline.html#from_rotated_box

Function

Class Method

PUBLIC

Constructs a rotated bounding box from its center, dimensions, and rotation.
fiftyone.core.labels._rotation_matrix

fiftyone.core.labels.html#_rotation_matrix

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels.Polylines

fiftyone.core.labels.Polylines.html

Class

Class

PUBLIC

A list of polylines or polygons in an image.
fiftyone.core.labels.Polylines.polylines

fiftyone.core.labels.Polylines.html#polylines

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Polylines._LABEL_LIST_FIELD

fiftyone.core.labels.Polylines.html#_LABEL_LIST_FIELD

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.labels.Polylines.to_detections

fiftyone.core.labels.Polylines.html#to_detections

Function

Method

PUBLIC

Returns a Detections representation of this instance whose bounding boxes tightly enclose the polylines.
fiftyone.core.labels.Polylines.to_segmentation

fiftyone.core.labels.Polylines.html#to_segmentation

Function

Method

PUBLIC

Returns a Segmentation representation of this instance.
fiftyone.core.labels.Keypoint

fiftyone.core.labels.Keypoint.html

Class

Class

PUBLIC

A list of keypoints in an image.
fiftyone.core.labels.Keypoint.label

fiftyone.core.labels.Keypoint.html#label

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Keypoint.points

fiftyone.core.labels.Keypoint.html#points

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Keypoint.confidence

fiftyone.core.labels.Keypoint.html#confidence

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Keypoint.index

fiftyone.core.labels.Keypoint.html#index

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Keypoint.to_shapely

fiftyone.core.labels.Keypoint.html#to_shapely

Function

Method

PUBLIC

Returns a Shapely representation of this instance.
fiftyone.core.labels.Keypoints

fiftyone.core.labels.Keypoints.html

Class

Class

PUBLIC

A list of Keypoint instances in an image.
fiftyone.core.labels.Keypoints.keypoints

fiftyone.core.labels.Keypoints.html#keypoints

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Keypoints._LABEL_LIST_FIELD

fiftyone.core.labels.Keypoints.html#_LABEL_LIST_FIELD

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.labels.Segmentation

fiftyone.core.labels.Segmentation.html

Class

Class

PUBLIC

A semantic segmentation for an image.
fiftyone.core.labels.Segmentation.mask

fiftyone.core.labels.Segmentation.html#mask

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.labels.Segmentation.mask_path

fiftyone.core.labels.Segmentation.html#mask_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.labels.Segmentation._MEDIA_FIELD

fiftyone.core.labels.Segmentation.html#_MEDIA_FIELD

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.labels.Segmentation.has_mask

fiftyone.core.labels.Segmentation.html#has_mask

Attribute

Property

PUBLIC

Whether this instance has a mask.
fiftyone.core.labels.Segmentation.get_mask

fiftyone.core.labels.Segmentation.html#get_mask

Function

Method

PUBLIC

Returns the segmentation mask for this instance.
fiftyone.core.labels.Segmentation.import_mask

fiftyone.core.labels.Segmentation.html#import_mask

Function

Method

PUBLIC

Imports this instance's mask from disk to its mask attribute.
fiftyone.core.labels.Segmentation.export_mask

fiftyone.core.labels.Segmentation.html#export_mask

Function

Method

PUBLIC

Exports this instance's mask to the given path.
fiftyone.core.labels.Segmentation.transform_mask

fiftyone.core.labels.Segmentation.html#transform_mask

Function

Method

PUBLIC

Transforms this instance's mask according to the provided targets map.
fiftyone.core.labels.Segmentation.to_detections

fiftyone.core.labels.Segmentation.html#to_detections

Function

Method

PUBLIC

Returns a Detections representation of this instance with instance masks populated.
fiftyone.core.labels.Segmentation.to_polylines

fiftyone.core.labels.Segmentation.html#to_polylines

Function

Method

PUBLIC

Returns a Polylines representation of this instance.
fiftyone.core.labels.Heatmap

fiftyone.core.labels.Heatmap.html

Class

Class

PUBLIC

A heatmap for an image.
fiftyone.core.labels.Heatmap.map

fiftyone.core.labels.Heatmap.html#map

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.labels.Heatmap.map_path

fiftyone.core.labels.Heatmap.html#map_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.labels.Heatmap.range

fiftyone.core.labels.Heatmap.html#range

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.Heatmap._MEDIA_FIELD

fiftyone.core.labels.Heatmap.html#_MEDIA_FIELD

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.labels.Heatmap.has_map

fiftyone.core.labels.Heatmap.html#has_map

Attribute

Property

PUBLIC

Whether this instance has a map.
fiftyone.core.labels.Heatmap.get_map

fiftyone.core.labels.Heatmap.html#get_map

Function

Method

PUBLIC

Returns the map array for this instance.
fiftyone.core.labels.Heatmap.import_map

fiftyone.core.labels.Heatmap.html#import_map

Function

Method

PUBLIC

Imports this instance's map from disk to its map attribute.
fiftyone.core.labels.Heatmap.export_map

fiftyone.core.labels.Heatmap.html#export_map

Function

Method

PUBLIC

Exports this instance's map to the given path.
fiftyone.core.labels.TemporalDetection

fiftyone.core.labels.TemporalDetection.html

Class

Class

PUBLIC

A temporal detection in a video whose support is defined by a start and end frame.
fiftyone.core.labels.TemporalDetection.label

fiftyone.core.labels.TemporalDetection.html#label

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.TemporalDetection.support

fiftyone.core.labels.TemporalDetection.html#support

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.TemporalDetection.confidence

fiftyone.core.labels.TemporalDetection.html#confidence

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.TemporalDetection.from_timestamps

fiftyone.core.labels.TemporalDetection.html#from_timestamps

Function

Class Method

PUBLIC

Creates a TemporalDetection instance from [start, stop] timestamps for the specified video.
fiftyone.core.labels.TemporalDetection.to_timestamps

fiftyone.core.labels.TemporalDetection.html#to_timestamps

Function

Method

PUBLIC

Returns the [start, stop] timestamps, in seconds, for this temporal detection in the given video.
fiftyone.core.labels._parse_video_metadata

fiftyone.core.labels.html#_parse_video_metadata

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels.TemporalDetections

fiftyone.core.labels.TemporalDetections.html

Class

Class

PUBLIC

A list of temporal detections for a video.
fiftyone.core.labels.TemporalDetections.detections

fiftyone.core.labels.TemporalDetections.html#detections

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.TemporalDetections._LABEL_LIST_FIELD

fiftyone.core.labels.TemporalDetections.html#_LABEL_LIST_FIELD

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.labels.GeoLocation

fiftyone.core.labels.GeoLocation.html

Class

Class

PUBLIC

Location data in GeoJSON format.
fiftyone.core.labels.GeoLocation.point

fiftyone.core.labels.GeoLocation.html#point

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.GeoLocation.line

fiftyone.core.labels.GeoLocation.html#line

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.GeoLocation.polygon

fiftyone.core.labels.GeoLocation.html#polygon

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.GeoLocation.to_geo_json

fiftyone.core.labels.GeoLocation.html#to_geo_json

Function

Method

PUBLIC

Returns a GeoJSON geometry dict for this instance.
fiftyone.core.labels.GeoLocation.from_geo_json

fiftyone.core.labels.GeoLocation.html#from_geo_json

Function

Class Method

PUBLIC

Creates a GeoLocation from a GeoJSON dictionary.
fiftyone.core.labels.GeoLocations

fiftyone.core.labels.GeoLocations.html

Class

Class

PUBLIC

A batch of location data in GeoJSON format.
fiftyone.core.labels.GeoLocations.points

fiftyone.core.labels.GeoLocations.html#points

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.GeoLocations.lines

fiftyone.core.labels.GeoLocations.html#lines

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.GeoLocations.polygons

fiftyone.core.labels.GeoLocations.html#polygons

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.labels.GeoLocations.to_geo_json

fiftyone.core.labels.GeoLocations.html#to_geo_json

Function

Method

PUBLIC

Returns a GeoJSON geometry dict for this instance.
fiftyone.core.labels.GeoLocations.from_geo_json

fiftyone.core.labels.GeoLocations.html#from_geo_json

Function

Class Method

PUBLIC

Creates a GeoLocation from a GeoJSON dictionary.
fiftyone.core.labels._LABEL_LIST_FIELDS

fiftyone.core.labels.html#_LABEL_LIST_FIELDS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.labels._PATCHES_FIELDS

fiftyone.core.labels.html#_PATCHES_FIELDS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.labels._INDEX_FIEDS

fiftyone.core.labels.html#_INDEX_FIEDS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.labels._SINGLE_LABEL_TO_LIST_MAP

fiftyone.core.labels.html#_SINGLE_LABEL_TO_LIST_MAP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.labels._LABEL_LIST_TO_SINGLE_MAP

fiftyone.core.labels.html#_LABEL_LIST_TO_SINGLE_MAP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.labels._read_mask

fiftyone.core.labels.html#_read_mask

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._write_mask

fiftyone.core.labels.html#_write_mask

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._transform_mask

fiftyone.core.labels.html#_transform_mask

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._mask_to_image

fiftyone.core.labels.html#_mask_to_image

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._read_heatmap

fiftyone.core.labels.html#_read_heatmap

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._write_heatmap

fiftyone.core.labels.html#_write_heatmap

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._heatmap_to_image

fiftyone.core.labels.html#_heatmap_to_image

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._parse_segmentation_target

fiftyone.core.labels.html#_parse_segmentation_target

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._parse_segmentation_mask_targets

fiftyone.core.labels.html#_parse_segmentation_mask_targets

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._render_instance

fiftyone.core.labels.html#_render_instance

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._render_polyline

fiftyone.core.labels.html#_render_polyline

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._find_slices

fiftyone.core.labels.html#_find_slices

Function

Function

PRIVATE

Return slices that tightly bound each unique object in mask.
fiftyone.core.labels._convert_segmentation

fiftyone.core.labels.html#_convert_segmentation

Function

Function

PRIVATE

Convert segmentation to a collection of detections, polylines, etc.
fiftyone.core.labels._mask_to_detections

fiftyone.core.labels.html#_mask_to_detections

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._mask_to_polylines

fiftyone.core.labels.html#_mask_to_polylines

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._segmentation_to_detections

fiftyone.core.labels.html#_segmentation_to_detections

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._segmentation_to_polylines

fiftyone.core.labels.html#_segmentation_to_polylines

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._hex_to_rgb

fiftyone.core.labels.html#_hex_to_rgb

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._rgb_to_hex

fiftyone.core.labels.html#_rgb_to_hex

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._hex_to_int

fiftyone.core.labels.html#_hex_to_int

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._int_to_hex

fiftyone.core.labels.html#_int_to_hex

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._rgb_array_to_int

fiftyone.core.labels.html#_rgb_array_to_int

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._int_array_to_rgb

fiftyone.core.labels.html#_int_array_to_rgb

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._parse_stuff_instance

fiftyone.core.labels.html#_parse_stuff_instance

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._parse_thing_instances

fiftyone.core.labels.html#_parse_thing_instances

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._get_polygons

fiftyone.core.labels.html#_get_polygons

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._from_geo_json_single

fiftyone.core.labels.html#_from_geo_json_single

Function

Function

PRIVATE

Undocumented
fiftyone.core.labels._from_geo_json

fiftyone.core.labels.html#_from_geo_json

Function

Function

PRIVATE

Undocumented
fiftyone.core.logging.logger

fiftyone.core.logging.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.logging.handler

fiftyone.core.logging.html#handler

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.logging.init_logging

fiftyone.core.logging.html#init_logging

Function

Function

PUBLIC

Initializes FiftyOne's package-wide logging.
fiftyone.core.logging.get_logging_level

fiftyone.core.logging.html#get_logging_level

Function

Function

PUBLIC

Gets FiftyOne's package-wide logging level.
fiftyone.core.logging.set_logging_level

fiftyone.core.logging.html#set_logging_level

Function

Function

PUBLIC

Sets FiftyOne's package-wide logging level.
fiftyone.core.logging._get_loggers

fiftyone.core.logging.html#_get_loggers

Function

Function

PRIVATE

Undocumented
fiftyone.core.logging._parse_logging_level

fiftyone.core.logging.html#_parse_logging_level

Function

Function

PRIVATE

Undocumented
fiftyone.core.metadata.logger

fiftyone.core.metadata.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.metadata.Metadata

fiftyone.core.metadata.Metadata.html

Class

Class

PUBLIC

Base class for storing metadata about generic samples.
fiftyone.core.metadata.Metadata.size_bytes

fiftyone.core.metadata.Metadata.html#size_bytes

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.metadata.Metadata.mime_type

fiftyone.core.metadata.Metadata.html#mime_type

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.metadata.Metadata.build_for

fiftyone.core.metadata.Metadata.html#build_for

Function

Class Method

PUBLIC

Builds a Metadata object for the given file.
fiftyone.core.metadata.Metadata._build_for_local

fiftyone.core.metadata.Metadata.html#_build_for_local

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.metadata.Metadata._build_for_url

fiftyone.core.metadata.Metadata.html#_build_for_url

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.metadata.ImageMetadata

fiftyone.core.metadata.ImageMetadata.html

Class

Class

PUBLIC

Class for storing metadata about image samples.
fiftyone.core.metadata.ImageMetadata.width

fiftyone.core.metadata.ImageMetadata.html#width

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.metadata.ImageMetadata.height

fiftyone.core.metadata.ImageMetadata.html#height

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.metadata.ImageMetadata.num_channels

fiftyone.core.metadata.ImageMetadata.html#num_channels

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.metadata.ImageMetadata.build_for

fiftyone.core.metadata.ImageMetadata.html#build_for

Function

Class Method

PUBLIC

Builds an ImageMetadata object for the given image.
fiftyone.core.metadata.ImageMetadata._build_for_local

fiftyone.core.metadata.ImageMetadata.html#_build_for_local

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.metadata.ImageMetadata._build_for_url

fiftyone.core.metadata.ImageMetadata.html#_build_for_url

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.metadata.ImageMetadata._build_for_img

fiftyone.core.metadata.ImageMetadata.html#_build_for_img

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.metadata.VideoMetadata

fiftyone.core.metadata.VideoMetadata.html

Class

Class

PUBLIC

Class for storing metadata about video samples.
fiftyone.core.metadata.VideoMetadata.frame_width

fiftyone.core.metadata.VideoMetadata.html#frame_width

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.metadata.VideoMetadata.frame_height

fiftyone.core.metadata.VideoMetadata.html#frame_height

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.metadata.VideoMetadata.frame_rate

fiftyone.core.metadata.VideoMetadata.html#frame_rate

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.metadata.VideoMetadata.total_frame_count

fiftyone.core.metadata.VideoMetadata.html#total_frame_count

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.metadata.VideoMetadata.duration

fiftyone.core.metadata.VideoMetadata.html#duration

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.metadata.VideoMetadata.encoding_str

fiftyone.core.metadata.VideoMetadata.html#encoding_str

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.metadata.VideoMetadata.build_for

fiftyone.core.metadata.VideoMetadata.html#build_for

Function

Class Method

PUBLIC

Builds an VideoMetadata object for the given video.
fiftyone.core.metadata.SceneMetadata

fiftyone.core.metadata.SceneMetadata.html

Class

Class

PUBLIC

Class for storing metadata about 3D scene samples.
fiftyone.core.metadata.SceneMetadata.asset_counts

fiftyone.core.metadata.SceneMetadata.html#asset_counts

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.metadata.SceneMetadata.build_for

fiftyone.core.metadata.SceneMetadata.html#build_for

Function

Class Method

PUBLIC

Builds a SceneMetadata object for the given 3D scene.
fiftyone.core.metadata.SceneMetadata._build_for_local

fiftyone.core.metadata.SceneMetadata.html#_build_for_local

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.metadata.SceneMetadata._build_for_url

fiftyone.core.metadata.SceneMetadata.html#_build_for_url

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.metadata._parse_assets

fiftyone.core.metadata.html#_parse_assets

Function

Function

PRIVATE

Undocumented
fiftyone.core.metadata.compute_sample_metadata

fiftyone.core.metadata.html#compute_sample_metadata

Function

Function

PUBLIC

Populates the metadata field of the sample.
fiftyone.core.metadata.get_metadata_cls

fiftyone.core.metadata.html#get_metadata_cls

Function

Function

PUBLIC

Get the metadata class for a media_type
fiftyone.core.metadata.compute_metadata

fiftyone.core.metadata.html#compute_metadata

Function

Function

PUBLIC

Populates the metadata field of all samples in the collection.
fiftyone.core.metadata._image_has_flipped_dimensions

fiftyone.core.metadata.html#_image_has_flipped_dimensions

Function

Function

PRIVATE

Returns True if image has flipped width/height dimensions
fiftyone.core.metadata.get_image_info

fiftyone.core.metadata.html#get_image_info

Function

Function

PUBLIC

Retrieves the dimensions and number of channels of the given image from a file-like object that is streaming its contents.
fiftyone.core.metadata._compute_metadata

fiftyone.core.metadata.html#_compute_metadata

Function

Function

PRIVATE

Undocumented
fiftyone.core.metadata._compute_metadata_multi

fiftyone.core.metadata.html#_compute_metadata_multi

Function

Function

PRIVATE

Undocumented
fiftyone.core.metadata._do_compute_metadata

fiftyone.core.metadata.html#_do_compute_metadata

Function

Function

PRIVATE

Undocumented
fiftyone.core.metadata._compute_sample_metadata

fiftyone.core.metadata.html#_compute_sample_metadata

Function

Function

PRIVATE

Undocumented
fiftyone.core.metadata._get_metadata

fiftyone.core.metadata.html#_get_metadata

Function

Function

PRIVATE

Undocumented
fiftyone.core.models.tud

fiftyone.core.models.html#tud

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.models.foue

fiftyone.core.models.html#foue

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.models.fouf

fiftyone.core.models.html#fouf

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.models.foui

fiftyone.core.models.html#foui

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.models.foup

fiftyone.core.models.html#foup

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.models.fous

fiftyone.core.models.html#fous

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.models.fout

fiftyone.core.models.html#fout

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.models.foutr

fiftyone.core.models.html#foutr

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.models.fouu

fiftyone.core.models.html#fouu

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.models.logger

fiftyone.core.models.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.models._ALLOWED_PATCH_TYPES

fiftyone.core.models.html#_ALLOWED_PATCH_TYPES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.models.apply_model

fiftyone.core.models.html#apply_model

Function

Function

PUBLIC

Applies the model to the samples in the collection.
fiftyone.core.models._is_flash_model

fiftyone.core.models.html#_is_flash_model

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._is_transformers_model

fiftyone.core.models.html#_is_transformers_model

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._is_ultralytics_model

fiftyone.core.models.html#_is_ultralytics_model

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._is_super_gradients_models

fiftyone.core.models.html#_is_super_gradients_models

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._convert_model_if_necessary

fiftyone.core.models.html#_convert_model_if_necessary

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._apply_image_model_single

fiftyone.core.models.html#_apply_image_model_single

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._apply_image_model_batch

fiftyone.core.models.html#_apply_image_model_batch

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._apply_image_model_data_loader

fiftyone.core.models.html#_apply_image_model_data_loader

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._apply_image_model_to_frames_single

fiftyone.core.models.html#_apply_image_model_to_frames_single

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._apply_image_model_to_frames_batch

fiftyone.core.models.html#_apply_image_model_to_frames_batch

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._apply_video_model

fiftyone.core.models.html#_apply_video_model

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._export_arrays

fiftyone.core.models.html#_export_arrays

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._do_export_array

fiftyone.core.models.html#_do_export_array

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._get_frame_counts

fiftyone.core.models.html#_get_frame_counts

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._iter_batches

fiftyone.core.models.html#_iter_batches

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._make_data_loader

fiftyone.core.models.html#_make_data_loader

Function

Function

PRIVATE

Undocumented
fiftyone.core.models.compute_embeddings

fiftyone.core.models.html#compute_embeddings

Function

Function

PUBLIC

Computes embeddings for the samples in the collection using the given model.
fiftyone.core.models._compute_image_embeddings_single

fiftyone.core.models.html#_compute_image_embeddings_single

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._compute_image_embeddings_batch

fiftyone.core.models.html#_compute_image_embeddings_batch

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._compute_image_embeddings_data_loader

fiftyone.core.models.html#_compute_image_embeddings_data_loader

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._compute_frame_embeddings_single

fiftyone.core.models.html#_compute_frame_embeddings_single

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._compute_frame_embeddings_batch

fiftyone.core.models.html#_compute_frame_embeddings_batch

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._compute_video_embeddings

fiftyone.core.models.html#_compute_video_embeddings

Function

Function

PRIVATE

Undocumented
fiftyone.core.models.compute_patch_embeddings

fiftyone.core.models.html#compute_patch_embeddings

Function

Function

PUBLIC

Computes embeddings for the image patches defined by patches_field of the samples in the collection using the given model.
fiftyone.core.models._embed_patches

fiftyone.core.models.html#_embed_patches

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._embed_patches_single

fiftyone.core.models.html#_embed_patches_single

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._embed_patches_batch

fiftyone.core.models.html#_embed_patches_batch

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._embed_patches_data_loader

fiftyone.core.models.html#_embed_patches_data_loader

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._embed_frame_patches

fiftyone.core.models.html#_embed_frame_patches

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._make_patch_data_loader

fiftyone.core.models.html#_make_patch_data_loader

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._parse_batch_size

fiftyone.core.models.html#_parse_batch_size

Function

Function

PRIVATE

Undocumented
fiftyone.core.models._make_label_parser

fiftyone.core.models.html#_make_label_parser

Function

Function

PRIVATE

Undocumented
fiftyone.core.models.load_model

fiftyone.core.models.html#load_model

Function

Function

PUBLIC

Loads the model specified by the given ModelConfig dict.
fiftyone.core.models._merge_config

fiftyone.core.models.html#_merge_config

Function

Function

PRIVATE

Undocumented
fiftyone.core.models.ModelConfig

fiftyone.core.models.ModelConfig.html

Class

Class

PUBLIC

Base configuration class that encapsulates the name of a Model and an instance of its associated Config class.
fiftyone.core.models.Model

fiftyone.core.models.Model.html

Class

Class

PUBLIC

Abstract base class for models.
fiftyone.core.models.Model.__enter__

fiftyone.core.models.Model.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.core.models.Model.__exit__

fiftyone.core.models.Model.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.core.models.Model.media_type

fiftyone.core.models.Model.html#media_type

Attribute

Property

PUBLIC

The media type processed by the model.
fiftyone.core.models.Model.has_logits

fiftyone.core.models.Model.html#has_logits

Attribute

Property

PUBLIC

Whether this instance can generate logits for its predictions.
fiftyone.core.models.Model.has_embeddings

fiftyone.core.models.Model.html#has_embeddings

Attribute

Property

PUBLIC

Whether this instance can generate embeddings.
fiftyone.core.models.Model.can_embed_prompts

fiftyone.core.models.Model.html#can_embed_prompts

Attribute

Property

PUBLIC

Whether this instance can generate prompt embeddings.
fiftyone.core.models.Model.ragged_batches

fiftyone.core.models.Model.html#ragged_batches

Attribute

Property

PUBLIC

True/False whether transforms may return tensors of different sizes. If True, then passing ragged lists of data to predict_all is not allowed.
fiftyone.core.models.Model.transforms

fiftyone.core.models.Model.html#transforms

Attribute

Property

PUBLIC

The preprocessing function that will/must be applied to each input before prediction, or None if no preprocessing is performed.
fiftyone.core.models.Model.preprocess

fiftyone.core.models.Model.html#preprocess

Attribute

Property

PUBLIC

Whether to apply transforms during inference (True) or to assume that they have already been applied (False).
fiftyone.core.models.Model.preprocess.setter

fiftyone.core.models.Model.html#preprocess.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.models.Model.predict

fiftyone.core.models.Model.html#predict

Function

Method

PUBLIC

Performs prediction on the given data.
fiftyone.core.models.Model.predict_all

fiftyone.core.models.Model.html#predict_all

Function

Method

PUBLIC

Performs prediction on the given iterable of data.
fiftyone.core.models.LogitsMixin

fiftyone.core.models.LogitsMixin.html

Class

Class

PUBLIC

Mixin for Model classes that can generate logits for their predictions.
fiftyone.core.models.LogitsMixin.__init__

fiftyone.core.models.LogitsMixin.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.models.LogitsMixin._store_logits

fiftyone.core.models.LogitsMixin.html#_store_logits

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.models.LogitsMixin.store_logits

fiftyone.core.models.LogitsMixin.html#store_logits

Attribute

Property

PUBLIC

Whether the model should store logits in its predictions.
fiftyone.core.models.LogitsMixin.store_logits.setter

fiftyone.core.models.LogitsMixin.html#store_logits.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.models.LogitsMixin.has_logits

fiftyone.core.models.LogitsMixin.html#has_logits

Attribute

Property

PUBLIC

Whether this instance can generate logits.
fiftyone.core.models.EmbeddingsMixin

fiftyone.core.models.EmbeddingsMixin.html

Class

Class

PUBLIC

Mixin for Model classes that can generate embeddings for their predictions.
fiftyone.core.models.EmbeddingsMixin.has_embeddings

fiftyone.core.models.EmbeddingsMixin.html#has_embeddings

Attribute

Property

PUBLIC

Whether this instance has embeddings.
fiftyone.core.models.EmbeddingsMixin.get_embeddings

fiftyone.core.models.EmbeddingsMixin.html#get_embeddings

Function

Method

PUBLIC

Returns the embeddings generated by the last forward pass of the model.
fiftyone.core.models.EmbeddingsMixin.embed

fiftyone.core.models.EmbeddingsMixin.html#embed

Function

Method

PUBLIC

Generates an embedding for the given data.
fiftyone.core.models.EmbeddingsMixin.embed_all

fiftyone.core.models.EmbeddingsMixin.html#embed_all

Function

Method

PUBLIC

Generates embeddings for the given iterable of data.
fiftyone.core.models.PromptMixin

fiftyone.core.models.PromptMixin.html

Class

Class

PUBLIC

Mixin for Model classes that can generate prompt embeddings.
fiftyone.core.models.PromptMixin.can_embed_prompts

fiftyone.core.models.PromptMixin.html#can_embed_prompts

Attribute

Property

PUBLIC

Whether this instance can generate prompt embeddings.
fiftyone.core.models.PromptMixin.embed_prompt

fiftyone.core.models.PromptMixin.html#embed_prompt

Function

Method

PUBLIC

Generates an embedding for the given prompt.
fiftyone.core.models.PromptMixin.embed_prompts

fiftyone.core.models.PromptMixin.html#embed_prompts

Function

Method

PUBLIC

Generates embeddings for the given prompts.
fiftyone.core.models.SamplesMixin

fiftyone.core.models.SamplesMixin.html

Class

Class

PUBLIC

Mixin for Model classes that need samples for prediction.
fiftyone.core.models.SamplesMixin.__init__

fiftyone.core.models.SamplesMixin.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.models.SamplesMixin._fields

fiftyone.core.models.SamplesMixin.html#_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.models.SamplesMixin.needs_fields

fiftyone.core.models.SamplesMixin.html#needs_fields

Attribute

Property

PUBLIC

A dict mapping model-specific keys to sample field names.
fiftyone.core.models.SamplesMixin.needs_fields.setter

fiftyone.core.models.SamplesMixin.html#needs_fields.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.models.SamplesMixin.predict

fiftyone.core.models.SamplesMixin.html#predict

Function

Method

PUBLIC

Performs prediction on the given data.
fiftyone.core.models.SamplesMixin.predict_all

fiftyone.core.models.SamplesMixin.html#predict_all

Function

Method

PUBLIC

Performs prediction on the given iterable of data.
fiftyone.core.models.TorchModelMixin

fiftyone.core.models.TorchModelMixin.html

Class

Class

PUBLIC

Mixin for Model classes that support feeding data for inference via a torch:torch.utils.data.DataLoader.
fiftyone.core.models.ModelManagerConfig

fiftyone.core.models.ModelManagerConfig.html

Class

Class

PUBLIC

Config settings for a ModelManager.
fiftyone.core.models.ModelManagerConfig.url

fiftyone.core.models.ModelManagerConfig.html#url

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.models.ModelManagerConfig.google_drive_id

fiftyone.core.models.ModelManagerConfig.html#google_drive_id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.models.ModelManagerConfig.__init__

fiftyone.core.models.ModelManagerConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.models.ModelManager

fiftyone.core.models.ModelManager.html

Class

Class

PUBLIC

Class for downloading FiftyOne models from the web.
fiftyone.core.models.ModelManager.upload_model

fiftyone.core.models.ModelManager.html#upload_model

Function

Static Method

PUBLIC

Undocumented
fiftyone.core.models.ModelManager._download_model

fiftyone.core.models.ModelManager.html#_download_model

Function

Method

PRIVATE

Undocumented
fiftyone.core.models.ModelManager.delete_model

fiftyone.core.models.ModelManager.html#delete_model

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.base.logger

fiftyone.core.plots.base.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.plots.base.plot_confusion_matrix

fiftyone.core.plots.base.html#plot_confusion_matrix

Function

Function

PUBLIC

Plots a confusion matrix.
fiftyone.core.plots.base.plot_regressions

fiftyone.core.plots.base.html#plot_regressions

Function

Function

PUBLIC

Plots the given regression results.
fiftyone.core.plots.base.plot_pr_curve

fiftyone.core.plots.base.html#plot_pr_curve

Function

Function

PUBLIC

Plots a precision-recall (PR) curve.
fiftyone.core.plots.base.plot_pr_curves

fiftyone.core.plots.base.html#plot_pr_curves

Function

Function

PUBLIC

Plots a set of per-class precision-recall (PR) curves.
fiftyone.core.plots.base.plot_roc_curve

fiftyone.core.plots.base.html#plot_roc_curve

Function

Function

PUBLIC

Plots a receiver operating characteristic (ROC) curve.
fiftyone.core.plots.base.lines

fiftyone.core.plots.base.html#lines

Function

Function

PUBLIC

Plots the given lines(s) data.
fiftyone.core.plots.base.scatterplot

fiftyone.core.plots.base.html#scatterplot

Function

Function

PUBLIC

Generates an interactive scatterplot of the given points.
fiftyone.core.plots.base.location_scatterplot

fiftyone.core.plots.base.html#location_scatterplot

Function

Function

PUBLIC

Generates an interactive scatterplot of the given location coordinates with a map rendered in the background of the plot.
fiftyone.core.plots.base._parse_backend

fiftyone.core.plots.base.html#_parse_backend

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.base.Plot

fiftyone.core.plots.base.Plot.html

Class

Class

PUBLIC

Base class for all plots.
fiftyone.core.plots.base.Plot._repr_pretty_

fiftyone.core.plots.base.Plot.html#_repr_pretty_

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.base.Plot.is_frozen

fiftyone.core.plots.base.Plot.html#is_frozen

Attribute

Property

PUBLIC

Whether this plot is currently frozen.
fiftyone.core.plots.base.Plot.show

fiftyone.core.plots.base.Plot.html#show

Function

Method

PUBLIC

Shows the plot.
fiftyone.core.plots.base.Plot.save

fiftyone.core.plots.base.Plot.html#save

Function

Method

PUBLIC

Saves the plot.
fiftyone.core.plots.base.Plot.freeze

fiftyone.core.plots.base.Plot.html#freeze

Function

Method

PUBLIC

Freezes the plot, replacing it with a static image.
fiftyone.core.plots.base.ResponsivePlot

fiftyone.core.plots.base.ResponsivePlot.html

Class

Class

PUBLIC

Base class for all responsive plots that can push/pull updates to a linked object.
fiftyone.core.plots.base.ResponsivePlot.__init__

fiftyone.core.plots.base.ResponsivePlot.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.base.ResponsivePlot._link_type

fiftyone.core.plots.base.ResponsivePlot.html#_link_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.base.ResponsivePlot._connected

fiftyone.core.plots.base.ResponsivePlot.html#_connected

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.base.ResponsivePlot._disconnected

fiftyone.core.plots.base.ResponsivePlot.html#_disconnected

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.base.ResponsivePlot._frozen

fiftyone.core.plots.base.ResponsivePlot.html#_frozen

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.base.ResponsivePlot.link_type

fiftyone.core.plots.base.ResponsivePlot.html#link_type

Attribute

Property

PUBLIC

The link type between this plot and a connected session.
fiftyone.core.plots.base.ResponsivePlot.supports_session_updates

fiftyone.core.plots.base.ResponsivePlot.html#supports_session_updates

Attribute

Property

PUBLIC

Whether this plot supports automatic updates in response to session changes.
fiftyone.core.plots.base.ResponsivePlot.is_connected

fiftyone.core.plots.base.ResponsivePlot.html#is_connected

Attribute

Property

PUBLIC

Whether this plot is currently connected.
fiftyone.core.plots.base.ResponsivePlot.is_disconnected

fiftyone.core.plots.base.ResponsivePlot.html#is_disconnected

Attribute

Property

PUBLIC

Whether this plot is currently disconnected.
fiftyone.core.plots.base.ResponsivePlot.is_frozen

fiftyone.core.plots.base.ResponsivePlot.html#is_frozen

Attribute

Property

PUBLIC

Whether this plot is currently frozen.
fiftyone.core.plots.base.ResponsivePlot.connect

fiftyone.core.plots.base.ResponsivePlot.html#connect

Function

Method

PUBLIC

Connects this plot, if necessary.
fiftyone.core.plots.base.ResponsivePlot._connect

fiftyone.core.plots.base.ResponsivePlot.html#_connect

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.base.ResponsivePlot.show

fiftyone.core.plots.base.ResponsivePlot.html#show

Function

Method

PUBLIC

Shows the plot.
fiftyone.core.plots.base.ResponsivePlot._show

fiftyone.core.plots.base.ResponsivePlot.html#_show

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.base.ResponsivePlot._reopen

fiftyone.core.plots.base.ResponsivePlot.html#_reopen

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.base.ResponsivePlot.reset

fiftyone.core.plots.base.ResponsivePlot.html#reset

Function

Method

PUBLIC

Resets the plot to its default state.
fiftyone.core.plots.base.ResponsivePlot.freeze

fiftyone.core.plots.base.ResponsivePlot.html#freeze

Function

Method

PUBLIC

Freezes the plot, replacing it with a static image.
fiftyone.core.plots.base.ResponsivePlot._freeze

fiftyone.core.plots.base.ResponsivePlot.html#_freeze

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.base.ResponsivePlot.disconnect

fiftyone.core.plots.base.ResponsivePlot.html#disconnect

Function

Method

PUBLIC

Disconnects the plot, if necessary.
fiftyone.core.plots.base.ResponsivePlot._disconnect

fiftyone.core.plots.base.ResponsivePlot.html#_disconnect

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.base.ViewPlot

fiftyone.core.plots.base.ViewPlot.html

Class

Class

PUBLIC

Base class for plots that can be automatically populated given a fiftyone.core.collections.SampleCollection instance.
fiftyone.core.plots.base.ViewPlot.init_view

fiftyone.core.plots.base.ViewPlot.html#init_view

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.base.ViewPlot.__init__

fiftyone.core.plots.base.ViewPlot.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.base.ViewPlot.supports_session_updates

fiftyone.core.plots.base.ViewPlot.html#supports_session_updates

Attribute

Property

PUBLIC

Whether this plot supports automatic updates in response to session changes.
fiftyone.core.plots.base.ViewPlot._get_aggregations

fiftyone.core.plots.base.ViewPlot.html#_get_aggregations

Function

Method

PRIVATE

Gets the fiftyone.core.aggregations.Aggregation instances that can compute the necessary data to serve this plot.
fiftyone.core.plots.base.ViewPlot.update_view

fiftyone.core.plots.base.ViewPlot.html#update_view

Function

Method

PUBLIC

Updates the plot based on the provided view.
fiftyone.core.plots.base.ViewPlot._update_view

fiftyone.core.plots.base.ViewPlot.html#_update_view

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.base.ViewPlot.reset

fiftyone.core.plots.base.ViewPlot.html#reset

Function

Method

PUBLIC

Resets the plot to its default state.
fiftyone.core.plots.base.InteractivePlot

fiftyone.core.plots.base.InteractivePlot.html

Class

Class

PUBLIC

Base class for plots that support selection of their points.
fiftyone.core.plots.base.InteractivePlot.label_fields

fiftyone.core.plots.base.InteractivePlot.html#label_fields

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.base.InteractivePlot.__init__

fiftyone.core.plots.base.InteractivePlot.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.base.InteractivePlot._init_view

fiftyone.core.plots.base.InteractivePlot.html#_init_view

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.base.InteractivePlot._init_fcn

fiftyone.core.plots.base.InteractivePlot.html#_init_fcn

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.base.InteractivePlot._init_fcn_view

fiftyone.core.plots.base.InteractivePlot.html#_init_fcn_view

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.base.InteractivePlot._selection_callback

fiftyone.core.plots.base.InteractivePlot.html#_selection_callback

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.base.InteractivePlot._sync_callback

fiftyone.core.plots.base.InteractivePlot.html#_sync_callback

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.base.InteractivePlot._disconnect_callback

fiftyone.core.plots.base.InteractivePlot.html#_disconnect_callback

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.base.InteractivePlot._selection_mode

fiftyone.core.plots.base.InteractivePlot.html#_selection_mode

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.base.InteractivePlot.selection_mode 0

fiftyone.core.plots.base.InteractivePlot.html#selection_mode%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.base.InteractivePlot.selection_mode

fiftyone.core.plots.base.InteractivePlot.html#selection_mode

Attribute

Property

PUBLIC

The current selection mode of the plot.
fiftyone.core.plots.base.InteractivePlot.selection_mode.setter

fiftyone.core.plots.base.InteractivePlot.html#selection_mode.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.base.InteractivePlot.init_view

fiftyone.core.plots.base.InteractivePlot.html#init_view

Attribute

Property

PUBLIC

A fiftyone.core.collections.SampleCollection defining the initial view from which to derive selection views when points are selected in the plot.
fiftyone.core.plots.base.InteractivePlot.selected_ids

fiftyone.core.plots.base.InteractivePlot.html#selected_ids

Attribute

Property

PUBLIC

A list of IDs of the currently selected points.
fiftyone.core.plots.base.InteractivePlot._selected_ids

fiftyone.core.plots.base.InteractivePlot.html#_selected_ids

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.plots.base.InteractivePlot.recommend_link_type

fiftyone.core.plots.base.InteractivePlot.html#recommend_link_type

Function

Static Method

PUBLIC

Recommends a link type for the given info.
fiftyone.core.plots.base.InteractivePlot.register_selection_callback

fiftyone.core.plots.base.InteractivePlot.html#register_selection_callback

Function

Method

PUBLIC

Registers a selection callback for this plot.
fiftyone.core.plots.base.InteractivePlot._register_selection_callback

fiftyone.core.plots.base.InteractivePlot.html#_register_selection_callback

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.base.InteractivePlot.register_sync_callback

fiftyone.core.plots.base.InteractivePlot.html#register_sync_callback

Function

Method

PUBLIC

Registers a callback that can sync this plot with a SessionPlot connected to it.
fiftyone.core.plots.base.InteractivePlot._register_sync_callback

fiftyone.core.plots.base.InteractivePlot.html#_register_sync_callback

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.base.InteractivePlot.register_disconnect_callback

fiftyone.core.plots.base.InteractivePlot.html#register_disconnect_callback

Function

Method

PUBLIC

Registers a callback that can disconnect this plot from a SessionPlot connected to it.
fiftyone.core.plots.base.InteractivePlot._register_disconnect_callback

fiftyone.core.plots.base.InteractivePlot.html#_register_disconnect_callback

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.base.InteractivePlot.select_ids

fiftyone.core.plots.base.InteractivePlot.html#select_ids

Function

Method

PUBLIC

Selects the points with the given IDs in this plot.
fiftyone.core.plots.base.InteractivePlot._select_ids

fiftyone.core.plots.base.InteractivePlot.html#_select_ids

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.base.InteractivePlot.reset

fiftyone.core.plots.base.InteractivePlot.html#reset

Function

Method

PUBLIC

Resets the plot to its default state.
fiftyone.core.plots.manager.logger

fiftyone.core.plots.manager.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.plots.manager.PlotManager

fiftyone.core.plots.manager.PlotManager.html

Class

Class

PUBLIC

Class that manages communication between a fiftyone.core.session.Session and one or more fiftyone.core.plots.base.ResponsivePlot instances.
fiftyone.core.plots.manager.PlotManager._MIN_UPDATE_DELTA_SECONDS

fiftyone.core.plots.manager.PlotManager.html#_MIN_UPDATE_DELTA_SECONDS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager.__init__

fiftyone.core.plots.manager.PlotManager.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.manager.PlotManager._session

fiftyone.core.plots.manager.PlotManager.html#_session

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._plots

fiftyone.core.plots.manager.PlotManager.html#_plots

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._aggs

fiftyone.core.plots.manager.PlotManager.html#_aggs

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._current_sample_ids

fiftyone.core.plots.manager.PlotManager.html#_current_sample_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._current_frame_ids

fiftyone.core.plots.manager.PlotManager.html#_current_frame_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._current_labels

fiftyone.core.plots.manager.PlotManager.html#_current_labels

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._last_session_view

fiftyone.core.plots.manager.PlotManager.html#_last_session_view

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._last_update

fiftyone.core.plots.manager.PlotManager.html#_last_update

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._last_updates

fiftyone.core.plots.manager.PlotManager.html#_last_updates

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._connected

fiftyone.core.plots.manager.PlotManager.html#_connected

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._disconnected

fiftyone.core.plots.manager.PlotManager.html#_disconnected

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager.__str__

fiftyone.core.plots.manager.PlotManager.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.manager.PlotManager.__repr__

fiftyone.core.plots.manager.PlotManager.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.manager.PlotManager.__iter__

fiftyone.core.plots.manager.PlotManager.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.manager.PlotManager.__contains__

fiftyone.core.plots.manager.PlotManager.html#__contains__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.manager.PlotManager.__setitem__

fiftyone.core.plots.manager.PlotManager.html#__setitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.manager.PlotManager.__getitem__

fiftyone.core.plots.manager.PlotManager.html#__getitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.manager.PlotManager.__delitem__

fiftyone.core.plots.manager.PlotManager.html#__delitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.manager.PlotManager.__bool__

fiftyone.core.plots.manager.PlotManager.html#__bool__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.manager.PlotManager.__len__

fiftyone.core.plots.manager.PlotManager.html#__len__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.manager.PlotManager._set_session

fiftyone.core.plots.manager.PlotManager.html#_set_session

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager.summary

fiftyone.core.plots.manager.PlotManager.html#summary

Function

Method

PUBLIC

Returns a string summary of this manager.
fiftyone.core.plots.manager.PlotManager._summarize_plots

fiftyone.core.plots.manager.PlotManager.html#_summarize_plots

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager.keys

fiftyone.core.plots.manager.PlotManager.html#keys

Function

Method

PUBLIC

Returns an iterator over the names of plots in this manager.
fiftyone.core.plots.manager.PlotManager.items

fiftyone.core.plots.manager.PlotManager.html#items

Function

Method

PUBLIC

Returns an iterator over the (name, plot) pairs in this manager.
fiftyone.core.plots.manager.PlotManager.values

fiftyone.core.plots.manager.PlotManager.html#values

Function

Method

PUBLIC

Returns an iterator over the plots in this manager.
fiftyone.core.plots.manager.PlotManager.is_connected

fiftyone.core.plots.manager.PlotManager.html#is_connected

Attribute

Property

PUBLIC

Whether this manager is currently connected to its plots.
fiftyone.core.plots.manager.PlotManager.is_disconnected

fiftyone.core.plots.manager.PlotManager.html#is_disconnected

Attribute

Property

PUBLIC

Whether this manager is currently disconnected from its plots.
fiftyone.core.plots.manager.PlotManager.has_view_links

fiftyone.core.plots.manager.PlotManager.html#has_view_links

Attribute

Property

PUBLIC

Whether this manager has plots linked to views.
fiftyone.core.plots.manager.PlotManager.has_sample_links

fiftyone.core.plots.manager.PlotManager.html#has_sample_links

Attribute

Property

PUBLIC

Whether this manager has plots linked to samples.
fiftyone.core.plots.manager.PlotManager.has_frame_links

fiftyone.core.plots.manager.PlotManager.html#has_frame_links

Attribute

Property

PUBLIC

Whether this manager has plots linked to frames.
fiftyone.core.plots.manager.PlotManager.has_label_links

fiftyone.core.plots.manager.PlotManager.html#has_label_links

Attribute

Property

PUBLIC

Whether this manager has plots linked to labels.
fiftyone.core.plots.manager.PlotManager.attach

fiftyone.core.plots.manager.PlotManager.html#attach

Function

Method

PUBLIC

Attaches a plot to this manager.
fiftyone.core.plots.manager.PlotManager.remove

fiftyone.core.plots.manager.PlotManager.html#remove

Function

Method

PUBLIC

Removes the plot from this manager.
fiftyone.core.plots.manager.PlotManager.clear

fiftyone.core.plots.manager.PlotManager.html#clear

Function

Method

PUBLIC

Removes all plots from this manager.
fiftyone.core.plots.manager.PlotManager.pop

fiftyone.core.plots.manager.PlotManager.html#pop

Function

Method

PUBLIC

Removes the plot from this manager and returns it.
fiftyone.core.plots.manager.PlotManager.connect

fiftyone.core.plots.manager.PlotManager.html#connect

Function

Method

PUBLIC

Connects this manager to its session and all plots.
fiftyone.core.plots.manager.PlotManager._connect_plot

fiftyone.core.plots.manager.PlotManager.html#_connect_plot

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager.disconnect

fiftyone.core.plots.manager.PlotManager.html#disconnect

Function

Method

PUBLIC

Disconnects this manager from its session and all plots.
fiftyone.core.plots.manager.PlotManager._disconnect_plot

fiftyone.core.plots.manager.PlotManager.html#_disconnect_plot

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager.sync

fiftyone.core.plots.manager.PlotManager.html#sync

Function

Method

PUBLIC

Syncs all connected plots with the session's current view.
fiftyone.core.plots.manager.PlotManager.freeze

fiftyone.core.plots.manager.PlotManager.html#freeze

Function

Method

PUBLIC

Freezes all connected plots, replacing them with static images.
fiftyone.core.plots.manager.PlotManager._on_session_update

fiftyone.core.plots.manager.PlotManager.html#_on_session_update

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._on_plot_selection

fiftyone.core.plots.manager.PlotManager.html#_on_plot_selection

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._update_ids_from_session

fiftyone.core.plots.manager.PlotManager.html#_update_ids_from_session

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._update_session

fiftyone.core.plots.manager.PlotManager.html#_update_session

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._update_plots_from_session

fiftyone.core.plots.manager.PlotManager.html#_update_plots_from_session

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._update_all_plots

fiftyone.core.plots.manager.PlotManager.html#_update_all_plots

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._update_plots

fiftyone.core.plots.manager.PlotManager.html#_update_plots

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._update_view_plots

fiftyone.core.plots.manager.PlotManager.html#_update_view_plots

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._update_interactive_plot

fiftyone.core.plots.manager.PlotManager.html#_update_interactive_plot

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._get_current_label_ids_for_plot

fiftyone.core.plots.manager.PlotManager.html#_get_current_label_ids_for_plot

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._ready_for_update

fiftyone.core.plots.manager.PlotManager.html#_ready_for_update

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.manager.PlotManager._needs_update

fiftyone.core.plots.manager.PlotManager.html#_needs_update

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.utils.parse_scatter_inputs

fiftyone.core.plots.utils.html#parse_scatter_inputs

Function

Function

PUBLIC

Undocumented
fiftyone.core.plots.utils.parse_locations

fiftyone.core.plots.utils.html#parse_locations

Function

Function

PUBLIC

Undocumented
fiftyone.core.plots.utils.parse_lines_inputs

fiftyone.core.plots.utils.html#parse_lines_inputs

Function

Function

PUBLIC

Undocumented
fiftyone.core.plots.utils.best_fit_line

fiftyone.core.plots.utils.html#best_fit_line

Function

Function

PUBLIC

Undocumented
fiftyone.core.plots.utils._is_expr

fiftyone.core.plots.utils.html#_is_expr

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.utils._parse_values

fiftyone.core.plots.utils.html#_parse_values

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.utils._get_ids

fiftyone.core.plots.utils.html#_get_ids

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.utils._unwind_values

fiftyone.core.plots.utils.html#_unwind_values

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.utils._validate_values

fiftyone.core.plots.utils.html#_validate_values

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.utils.load_button_icon

fiftyone.core.plots.utils.html#load_button_icon

Function

Function

PUBLIC

Undocumented
fiftyone.core.plots.utils.load_icon

fiftyone.core.plots.utils.html#load_icon

Function

Function

PUBLIC

Undocumented
fiftyone.core.plots.utils.serialize_icon

fiftyone.core.plots.utils.html#serialize_icon

Function

Function

PUBLIC

Undocumented
fiftyone.core.plots.utils.pad_icon

fiftyone.core.plots.utils.html#pad_icon

Function

Function

PUBLIC

Undocumented
fiftyone.core.plots.utils._BUTTON_ICONS

fiftyone.core.plots.utils.html#_BUTTON_ICONS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.plots.plotly.logger

fiftyone.core.plots.plotly.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.plots.plotly._DEFAULT_LAYOUT

fiftyone.core.plots.plotly.html#_DEFAULT_LAYOUT

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.plots.plotly._DEFAULT_LINE_COLOR

fiftyone.core.plots.plotly.html#_DEFAULT_LINE_COLOR

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.plots.plotly._DEFAULT_CONTINUOUS_COLORSCALE

fiftyone.core.plots.plotly.html#_DEFAULT_CONTINUOUS_COLORSCALE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.plots.plotly._MAX_LABEL_TRACES

fiftyone.core.plots.plotly.html#_MAX_LABEL_TRACES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.plots.plotly.plot_confusion_matrix

fiftyone.core.plots.plotly.html#plot_confusion_matrix

Function

Function

PUBLIC

Plots a confusion matrix.
fiftyone.core.plots.plotly._plot_confusion_matrix_static

fiftyone.core.plots.plotly.html#_plot_confusion_matrix_static

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._plot_confusion_matrix_interactive

fiftyone.core.plots.plotly.html#_plot_confusion_matrix_interactive

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly.plot_regressions

fiftyone.core.plots.plotly.html#plot_regressions

Function

Function

PUBLIC

Plots the given regression results.
fiftyone.core.plots.plotly.plot_pr_curve

fiftyone.core.plots.plotly.html#plot_pr_curve

Function

Function

PUBLIC

Plots a precision-recall (PR) curve.
fiftyone.core.plots.plotly.plot_pr_curves

fiftyone.core.plots.plotly.html#plot_pr_curves

Function

Function

PUBLIC

Plots a set of per-class precision-recall (PR) curves.
fiftyone.core.plots.plotly.plot_roc_curve

fiftyone.core.plots.plotly.html#plot_roc_curve

Function

Function

PUBLIC

Plots a receiver operating characteristic (ROC) curve.
fiftyone.core.plots.plotly.lines

fiftyone.core.plots.plotly.html#lines

Function

Function

PUBLIC

Plots the given lines(s) data.
fiftyone.core.plots.plotly.scatterplot

fiftyone.core.plots.plotly.html#scatterplot

Function

Function

PUBLIC

Generates an interactive scatterplot of the given points.
fiftyone.core.plots.plotly._parse_titles

fiftyone.core.plots.plotly.html#_parse_titles

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly.location_scatterplot

fiftyone.core.plots.plotly.html#location_scatterplot

Function

Function

PUBLIC

Generates an interactive scatterplot of the given location coordinates with a map rendered in the background of the plot.
fiftyone.core.plots.plotly.get_colormap

fiftyone.core.plots.plotly.html#get_colormap

Function

Function

PUBLIC

Generates a continuous colormap with the specified number of colors from the given plotly colorscale.
fiftyone.core.plots.plotly._to_log_colorscale

fiftyone.core.plots.plotly.html#_to_log_colorscale

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._get_colorscale

fiftyone.core.plots.plotly.html#_get_colorscale

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._get_continuous_color

fiftyone.core.plots.plotly.html#_get_continuous_color

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly.PlotlyWidgetMixin

fiftyone.core.plots.plotly.PlotlyWidgetMixin.html

Class

Class

PUBLIC

Mixin for Plotly plots that use widgets to display in Jupyter notebooks.
fiftyone.core.plots.plotly.PlotlyWidgetMixin.__init__

fiftyone.core.plots.plotly.PlotlyWidgetMixin.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.plotly.PlotlyWidgetMixin._widget

fiftyone.core.plots.plotly.PlotlyWidgetMixin.html#_widget

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.PlotlyWidgetMixin._handle

fiftyone.core.plots.plotly.PlotlyWidgetMixin.html#_handle

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.PlotlyWidgetMixin.save

fiftyone.core.plots.plotly.PlotlyWidgetMixin.html#save

Function

Method

PUBLIC

Saves the plot as an image or HTML.
fiftyone.core.plots.plotly.PlotlyWidgetMixin._update_layout

fiftyone.core.plots.plotly.PlotlyWidgetMixin.html#_update_layout

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.PlotlyWidgetMixin._show

fiftyone.core.plots.plotly.PlotlyWidgetMixin.html#_show

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.PlotlyWidgetMixin._freeze

fiftyone.core.plots.plotly.PlotlyWidgetMixin.html#_freeze

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.PlotlyWidgetMixin._screenshot

fiftyone.core.plots.plotly.PlotlyWidgetMixin.html#_screenshot

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly._check_plotly_jupyter_environment

fiftyone.core.plots.plotly.html#_check_plotly_jupyter_environment

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly.PlotlyNotebookPlot

fiftyone.core.plots.plotly.PlotlyNotebookPlot.html

Class

Class

PUBLIC

A wrapper around a Plotly plot for Jupyter notebook contexts that allows it to be replaced with a screenshot by calling freeze.
fiftyone.core.plots.plotly.PlotlyNotebookPlot.__init__

fiftyone.core.plots.plotly.PlotlyNotebookPlot.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.plotly.PlotlyNotebookPlot._figure

fiftyone.core.plots.plotly.PlotlyNotebookPlot.html#_figure

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.PlotlyNotebookPlot._frozen

fiftyone.core.plots.plotly.PlotlyNotebookPlot.html#_frozen

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.PlotlyNotebookPlot.is_frozen

fiftyone.core.plots.plotly.PlotlyNotebookPlot.html#is_frozen

Attribute

Property

PUBLIC

Whether this plot is currently frozen.
fiftyone.core.plots.plotly.PlotlyNotebookPlot.update_layout

fiftyone.core.plots.plotly.PlotlyNotebookPlot.html#update_layout

Function

Method

PUBLIC

Updates the layout of the plot.
fiftyone.core.plots.plotly.PlotlyNotebookPlot.show

fiftyone.core.plots.plotly.PlotlyNotebookPlot.html#show

Function

Method

PUBLIC

Shows the plot.
fiftyone.core.plots.plotly.PlotlyNotebookPlot.freeze

fiftyone.core.plots.plotly.PlotlyNotebookPlot.html#freeze

Function

Method

PUBLIC

Freezes the plot, replacing it with a static image.
fiftyone.core.plots.plotly.PlotlyNotebookPlot._make_widget

fiftyone.core.plots.plotly.PlotlyNotebookPlot.html#_make_widget

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.PlotlyNotebookPlot._reopen

fiftyone.core.plots.plotly.PlotlyNotebookPlot.html#_reopen

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.PlotlyNotebookPlot._widget

fiftyone.core.plots.plotly.PlotlyNotebookPlot.html#_widget

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.PlotlyInteractivePlot

fiftyone.core.plots.plotly.PlotlyInteractivePlot.html

Class

Class

PUBLIC

Base class for fiftyone.core.plots.base.InteractivePlot instances with Plotly backends.
fiftyone.core.plots.plotly.PlotlyInteractivePlot.__init__

fiftyone.core.plots.plotly.PlotlyInteractivePlot.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.plotly.PlotlyInteractivePlot.update_layout

fiftyone.core.plots.plotly.PlotlyInteractivePlot.html#update_layout

Function

Method

PUBLIC

Updates the layout of the plot.
fiftyone.core.plots.plotly.PlotlyInteractivePlot.show

fiftyone.core.plots.plotly.PlotlyInteractivePlot.html#show

Function

Method

PUBLIC

Shows the plot.
fiftyone.core.plots.plotly.InteractiveScatter

fiftyone.core.plots.plotly.InteractiveScatter.html

Class

Class

PUBLIC

Wrapper class that turns a Plotly figure containing one or more scatter-type traces into an fiftyone.core.plots.base.InteractivePlot.
fiftyone.core.plots.plotly.InteractiveScatter.__init__

fiftyone.core.plots.plotly.InteractiveScatter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter._figure

fiftyone.core.plots.plotly.InteractiveScatter.html#_figure

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter._traces

fiftyone.core.plots.plotly.InteractiveScatter.html#_traces

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter._trace_ids

fiftyone.core.plots.plotly.InteractiveScatter.html#_trace_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter._ids_to_traces

fiftyone.core.plots.plotly.InteractiveScatter.html#_ids_to_traces

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter._ids_to_inds

fiftyone.core.plots.plotly.InteractiveScatter.html#_ids_to_inds

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter._callback_flags

fiftyone.core.plots.plotly.InteractiveScatter.html#_callback_flags

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter._init_traces

fiftyone.core.plots.plotly.InteractiveScatter.html#_init_traces

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter._init_callback_flags

fiftyone.core.plots.plotly.InteractiveScatter.html#_init_callback_flags

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter.supports_session_updates

fiftyone.core.plots.plotly.InteractiveScatter.html#supports_session_updates

Attribute

Property

PUBLIC

Whether this plot supports automatic updates in response to session changes.
fiftyone.core.plots.plotly.InteractiveScatter._selected_ids

fiftyone.core.plots.plotly.InteractiveScatter.html#_selected_ids

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter._make_widget

fiftyone.core.plots.plotly.InteractiveScatter.html#_make_widget

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter._connect

fiftyone.core.plots.plotly.InteractiveScatter.html#_connect

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter._disconnect

fiftyone.core.plots.plotly.InteractiveScatter.html#_disconnect

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter._reopen

fiftyone.core.plots.plotly.InteractiveScatter.html#_reopen

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter._widget

fiftyone.core.plots.plotly.InteractiveScatter.html#_widget

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter._select_ids

fiftyone.core.plots.plotly.InteractiveScatter.html#_select_ids

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter._on_select

fiftyone.core.plots.plotly.InteractiveScatter.html#_on_select

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveScatter._ready_for_callback

fiftyone.core.plots.plotly.InteractiveScatter.html#_ready_for_callback

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap

fiftyone.core.plots.plotly.InteractiveHeatmap.html

Class

Class

PUBLIC

An interactive Plotly heatmap.
fiftyone.core.plots.plotly.InteractiveHeatmap.xlabels

fiftyone.core.plots.plotly.InteractiveHeatmap.html#xlabels

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap.ylabels

fiftyone.core.plots.plotly.InteractiveHeatmap.html#ylabels

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap.zlim

fiftyone.core.plots.plotly.InteractiveHeatmap.html#zlim

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap.values_title

fiftyone.core.plots.plotly.InteractiveHeatmap.html#values_title

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap.gt_field

fiftyone.core.plots.plotly.InteractiveHeatmap.html#gt_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap.pred_field

fiftyone.core.plots.plotly.InteractiveHeatmap.html#pred_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap.colorscale

fiftyone.core.plots.plotly.InteractiveHeatmap.html#colorscale

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap.grid_opacity

fiftyone.core.plots.plotly.InteractiveHeatmap.html#grid_opacity

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap.bg_opacity

fiftyone.core.plots.plotly.InteractiveHeatmap.html#bg_opacity

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap.__init__

fiftyone.core.plots.plotly.InteractiveHeatmap.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap.Z

fiftyone.core.plots.plotly.InteractiveHeatmap.html#Z

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap.ids

fiftyone.core.plots.plotly.InteractiveHeatmap.html#ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._figure

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_figure

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._gridw

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_gridw

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._selectedw

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_selectedw

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._bgw

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_bgw

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._selected_cells

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_selected_cells

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._curr_view

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_curr_view

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._curr_ids

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_curr_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._curr_Z

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_curr_Z

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._curr_zlim

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_curr_zlim

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._cells_map

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_cells_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap.supports_session_updates

fiftyone.core.plots.plotly.InteractiveHeatmap.html#supports_session_updates

Attribute

Property

PUBLIC

Whether this plot supports automatic updates in response to session changes.
fiftyone.core.plots.plotly.InteractiveHeatmap.init_view

fiftyone.core.plots.plotly.InteractiveHeatmap.html#init_view

Attribute

Property

PUBLIC

A fiftyone.core.collections.SampleCollection defining the initial view from which to derive selection views when points are selected in the plot.
fiftyone.core.plots.plotly.InteractiveHeatmap._selected_ids

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_selected_ids

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._make_widget

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_make_widget

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._connect

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_connect

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._disconnect

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_disconnect

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._reopen

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_reopen

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._widget

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_widget

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._select_ids

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_select_ids

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._on_click

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_on_click

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._on_selection

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_on_selection

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._deselect

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_deselect

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._select_cells

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_select_cells

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._update_heatmap

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_update_heatmap

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._init_cells_map

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_init_cells_map

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly.InteractiveHeatmap._make_heatmap

fiftyone.core.plots.plotly.InteractiveHeatmap.html#_make_heatmap

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.plotly._plot_scatter_categorical

fiftyone.core.plots.plotly.html#_plot_scatter_categorical

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._plot_scatter_categorical_single_trace

fiftyone.core.plots.plotly.html#_plot_scatter_categorical_single_trace

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._plot_scatter_numeric

fiftyone.core.plots.plotly.html#_plot_scatter_numeric

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._set_map_type_to_figure 0

fiftyone.core.plots.plotly.html#_set_map_type_to_figure%200

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._set_map_type_to_figure

fiftyone.core.plots.plotly.html#_set_map_type_to_figure

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._plot_scatter_mapbox_categorical

fiftyone.core.plots.plotly.html#_plot_scatter_mapbox_categorical

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._plot_scatter_mapbox_categorical_single_trace

fiftyone.core.plots.plotly.html#_plot_scatter_mapbox_categorical_single_trace

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._plot_scatter_mapbox_numeric

fiftyone.core.plots.plotly.html#_plot_scatter_mapbox_numeric

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._plot_scatter_mapbox_density

fiftyone.core.plots.plotly.html#_plot_scatter_mapbox_density

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._make_edges_scatter

fiftyone.core.plots.plotly.html#_make_edges_scatter

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._make_edges_scatter_mapbox

fiftyone.core.plots.plotly.html#_make_edges_scatter_mapbox

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._get_qualitative_colors

fiftyone.core.plots.plotly.html#_get_qualitative_colors

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._get_qualitative_colorscale

fiftyone.core.plots.plotly.html#_get_qualitative_colorscale

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._compute_zoom_center

fiftyone.core.plots.plotly.html#_compute_zoom_center

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.plotly._patch_perform_plotly_relayout

fiftyone.core.plots.plotly.html#_patch_perform_plotly_relayout

Function

Function

PRIVATE

Attempts to patch an unresolved issue with zooming/panning FigureWidgets with Mapbox plots.
fiftyone.core.plots.views._DEFAULT_LAYOUT

fiftyone.core.plots.views.html#_DEFAULT_LAYOUT

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.plots.views._DEFAULT_MARKER_COLOR

fiftyone.core.plots.views.html#_DEFAULT_MARKER_COLOR

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.plots.views.PlotlyViewPlot

fiftyone.core.plots.views.PlotlyViewPlot.html

Class

Class

PUBLIC

Base class for ViewPlot instances with Plotly backends.
fiftyone.core.plots.views.PlotlyViewPlot.init_view

fiftyone.core.plots.views.PlotlyViewPlot.html#init_view

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.PlotlyViewPlot.__init__

fiftyone.core.plots.views.PlotlyViewPlot.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.views.PlotlyViewPlot._traces

fiftyone.core.plots.views.PlotlyViewPlot.html#_traces

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.views.PlotlyViewPlot._get_trace_updates

fiftyone.core.plots.views.PlotlyViewPlot.html#_get_trace_updates

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.views.PlotlyViewPlot._update_view

fiftyone.core.plots.views.PlotlyViewPlot.html#_update_view

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.views.PlotlyViewPlot.show

fiftyone.core.plots.views.PlotlyViewPlot.html#show

Function

Method

PUBLIC

Shows this plot.
fiftyone.core.plots.views.ViewGrid

fiftyone.core.plots.views.ViewGrid.html

Class

Class

PUBLIC

A grid of PlotlyViewPlot instances.
fiftyone.core.plots.views.ViewGrid.shape

fiftyone.core.plots.views.ViewGrid.html#shape

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.ViewGrid.hgap

fiftyone.core.plots.views.ViewGrid.html#hgap

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.ViewGrid.vgap

fiftyone.core.plots.views.ViewGrid.html#vgap

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.ViewGrid.__init__

fiftyone.core.plots.views.ViewGrid.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.views.ViewGrid.plots

fiftyone.core.plots.views.ViewGrid.html#plots

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.ViewGrid.layout

fiftyone.core.plots.views.ViewGrid.html#layout

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.ViewGrid._aggregations

fiftyone.core.plots.views.ViewGrid.html#_aggregations

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.views.ViewGrid._agg_lengths

fiftyone.core.plots.views.ViewGrid.html#_agg_lengths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.views.ViewGrid._init_aggregations

fiftyone.core.plots.views.ViewGrid.html#_init_aggregations

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.views.ViewGrid._get_aggregations

fiftyone.core.plots.views.ViewGrid.html#_get_aggregations

Function

Method

PRIVATE

Gets the fiftyone.core.aggregations.Aggregation instances that can compute the necessary data to serve this plot.
fiftyone.core.plots.views.ViewGrid._make_widget

fiftyone.core.plots.views.ViewGrid.html#_make_widget

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.views.ViewGrid._get_trace_updates

fiftyone.core.plots.views.ViewGrid.html#_get_trace_updates

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.views.ViewGrid._reopen

fiftyone.core.plots.views.ViewGrid.html#_reopen

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.views.ViewGrid._widget

fiftyone.core.plots.views.ViewGrid.html#_widget

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.views.ViewGrid._traces

fiftyone.core.plots.views.ViewGrid.html#_traces

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.views.CategoricalHistogram

fiftyone.core.plots.views.CategoricalHistogram.html

Class

Class

PUBLIC

A histogram of a categorial field.
fiftyone.core.plots.views.CategoricalHistogram.expr

fiftyone.core.plots.views.CategoricalHistogram.html#expr

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.CategoricalHistogram.order

fiftyone.core.plots.views.CategoricalHistogram.html#order

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.CategoricalHistogram.xlabel

fiftyone.core.plots.views.CategoricalHistogram.html#xlabel

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.CategoricalHistogram.log

fiftyone.core.plots.views.CategoricalHistogram.html#log

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.CategoricalHistogram.bargap

fiftyone.core.plots.views.CategoricalHistogram.html#bargap

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.CategoricalHistogram.color

fiftyone.core.plots.views.CategoricalHistogram.html#color

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.CategoricalHistogram.opacity

fiftyone.core.plots.views.CategoricalHistogram.html#opacity

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.CategoricalHistogram.__init__

fiftyone.core.plots.views.CategoricalHistogram.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.views.CategoricalHistogram.field_or_expr

fiftyone.core.plots.views.CategoricalHistogram.html#field_or_expr

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.CategoricalHistogram.layout

fiftyone.core.plots.views.CategoricalHistogram.html#layout

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.CategoricalHistogram._order

fiftyone.core.plots.views.CategoricalHistogram.html#_order

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.views.CategoricalHistogram._reverse

fiftyone.core.plots.views.CategoricalHistogram.html#_reverse

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.views.CategoricalHistogram._figure

fiftyone.core.plots.views.CategoricalHistogram.html#_figure

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.views.CategoricalHistogram._aggregations

fiftyone.core.plots.views.CategoricalHistogram.html#_aggregations

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.views.CategoricalHistogram._make_widget

fiftyone.core.plots.views.CategoricalHistogram.html#_make_widget

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.views.CategoricalHistogram._make_histogram

fiftyone.core.plots.views.CategoricalHistogram.html#_make_histogram

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.views.CategoricalHistogram._get_aggregations

fiftyone.core.plots.views.CategoricalHistogram.html#_get_aggregations

Function

Method

PRIVATE

Gets the fiftyone.core.aggregations.Aggregation instances that can compute the necessary data to serve this plot.
fiftyone.core.plots.views.CategoricalHistogram._get_trace_updates

fiftyone.core.plots.views.CategoricalHistogram.html#_get_trace_updates

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.views.CategoricalHistogram._reopen

fiftyone.core.plots.views.CategoricalHistogram.html#_reopen

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.views.CategoricalHistogram._widget

fiftyone.core.plots.views.CategoricalHistogram.html#_widget

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.views.CategoricalHistogram._traces

fiftyone.core.plots.views.CategoricalHistogram.html#_traces

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.views.NumericalHistogram

fiftyone.core.plots.views.NumericalHistogram.html

Class

Class

PUBLIC

A histogram of a numerical field.
fiftyone.core.plots.views.NumericalHistogram.expr

fiftyone.core.plots.views.NumericalHistogram.html#expr

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.NumericalHistogram.bins

fiftyone.core.plots.views.NumericalHistogram.html#bins

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.NumericalHistogram.range

fiftyone.core.plots.views.NumericalHistogram.html#range

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.NumericalHistogram.xlabel

fiftyone.core.plots.views.NumericalHistogram.html#xlabel

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.NumericalHistogram.log

fiftyone.core.plots.views.NumericalHistogram.html#log

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.NumericalHistogram.color

fiftyone.core.plots.views.NumericalHistogram.html#color

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.NumericalHistogram.opacity

fiftyone.core.plots.views.NumericalHistogram.html#opacity

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.NumericalHistogram.__init__

fiftyone.core.plots.views.NumericalHistogram.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.views.NumericalHistogram.field_or_expr

fiftyone.core.plots.views.NumericalHistogram.html#field_or_expr

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.NumericalHistogram.layout

fiftyone.core.plots.views.NumericalHistogram.html#layout

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.views.NumericalHistogram._figure

fiftyone.core.plots.views.NumericalHistogram.html#_figure

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.views.NumericalHistogram._aggregations

fiftyone.core.plots.views.NumericalHistogram.html#_aggregations

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.views.NumericalHistogram._make_widget

fiftyone.core.plots.views.NumericalHistogram.html#_make_widget

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.views.NumericalHistogram._make_histogram

fiftyone.core.plots.views.NumericalHistogram.html#_make_histogram

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.views.NumericalHistogram._get_aggregations

fiftyone.core.plots.views.NumericalHistogram.html#_get_aggregations

Function

Method

PRIVATE

Gets the fiftyone.core.aggregations.Aggregation instances that can compute the necessary data to serve this plot.
fiftyone.core.plots.views.NumericalHistogram._get_trace_updates

fiftyone.core.plots.views.NumericalHistogram.html#_get_trace_updates

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.views.NumericalHistogram._reopen

fiftyone.core.plots.views.NumericalHistogram.html#_reopen

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.views.NumericalHistogram._widget

fiftyone.core.plots.views.NumericalHistogram.html#_widget

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.views.NumericalHistogram._traces

fiftyone.core.plots.views.NumericalHistogram.html#_traces

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.views._make_composite_widget

fiftyone.core.plots.views.html#_make_composite_widget

Function

Function

PRIVATE

Undocumented
fiftyone.core.runs.logger

fiftyone.core.runs.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.runs.BaseRunInfo

fiftyone.core.runs.BaseRunInfo.html

Class

Class

PUBLIC

Information about a run on a dataset.
fiftyone.core.runs.BaseRunInfo.version

fiftyone.core.runs.BaseRunInfo.html#version

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.runs.BaseRunInfo.timestamp

fiftyone.core.runs.BaseRunInfo.html#timestamp

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.runs.BaseRunInfo.config

fiftyone.core.runs.BaseRunInfo.html#config

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.runs.BaseRunInfo.__init__

fiftyone.core.runs.BaseRunInfo.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.runs.BaseRunInfo.key

fiftyone.core.runs.BaseRunInfo.html#key

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.runs.BaseRunInfo.config_cls

fiftyone.core.runs.BaseRunInfo.html#config_cls

Function

Class Method

PUBLIC

The BaseRunConfig class associated with this class.
fiftyone.core.runs.BaseRunInfo._from_doc

fiftyone.core.runs.BaseRunInfo.html#_from_doc

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.runs.BaseRunConfig

fiftyone.core.runs.BaseRunConfig.html

Class

Class

PUBLIC

Base class for configuring BaseRun instances.
fiftyone.core.runs.BaseRunConfig.__init__

fiftyone.core.runs.BaseRunConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.runs.BaseRunConfig.type

fiftyone.core.runs.BaseRunConfig.html#type

Attribute

Property

PUBLIC

The type of run.
fiftyone.core.runs.BaseRunConfig.method

fiftyone.core.runs.BaseRunConfig.html#method

Attribute

Property

PUBLIC

The name of the method.
fiftyone.core.runs.BaseRunConfig.cls

fiftyone.core.runs.BaseRunConfig.html#cls

Attribute

Property

PUBLIC

The fully-qualified name of this BaseRunConfig class.
fiftyone.core.runs.BaseRunConfig.run_cls

fiftyone.core.runs.BaseRunConfig.html#run_cls

Attribute

Property

PUBLIC

The BaseRun class associated with this config.
fiftyone.core.runs.BaseRunConfig.load_credentials

fiftyone.core.runs.BaseRunConfig.html#load_credentials

Function

Method

PUBLIC

Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config.
fiftyone.core.runs.BaseRunConfig.build

fiftyone.core.runs.BaseRunConfig.html#build

Function

Method

PUBLIC

Builds the BaseRun instance associated with this config.
fiftyone.core.runs.BaseRunConfig.attributes

fiftyone.core.runs.BaseRunConfig.html#attributes

Function

Method

PUBLIC

Returns the list of class attributes that will be serialized by serialize.
fiftyone.core.runs.BaseRunConfig._virtual_attributes

fiftyone.core.runs.BaseRunConfig.html#_virtual_attributes

Function

Class Method

PRIVATE

A list of attributes that are serialized but should not be treated as parameters when loading the config class from the database.
fiftyone.core.runs.BaseRunConfig.from_dict

fiftyone.core.runs.BaseRunConfig.html#from_dict

Function

Class Method

PUBLIC

Constructs a BaseRunConfig from a serialized JSON dict representation of it.
fiftyone.core.runs.BaseRunConfig.base_config_cls

fiftyone.core.runs.BaseRunConfig.html#base_config_cls

Function

Static Method

PUBLIC

Returns the config class for the given run type.
fiftyone.core.runs.BaseRun

fiftyone.core.runs.BaseRun.html

Class

Class

PUBLIC

Base class for methods that can be run on a dataset.
fiftyone.core.runs.BaseRun.run_info_cls

fiftyone.core.runs.BaseRun.html#run_info_cls

Function

Class Method

PUBLIC

The BaseRunInfo class associated with this class.
fiftyone.core.runs.BaseRun._runs_field

fiftyone.core.runs.BaseRun.html#_runs_field

Function

Class Method

PRIVATE

The fiftyone.core.odm.dataset.DatasetDocument field in which these runs are stored.
fiftyone.core.runs.BaseRun._run_str

fiftyone.core.runs.BaseRun.html#_run_str

Function

Class Method

PRIVATE

A string to use when referring to these runs in log messages.
fiftyone.core.runs.BaseRun._patch_function

fiftyone.core.runs.BaseRun.html#_patch_function

Function

Class Method

PRIVATE

A function that can patch any ReferenceField issues with a dataset's runs.
fiftyone.core.runs.BaseRun._results_cache_field

fiftyone.core.runs.BaseRun.html#_results_cache_field

Function

Class Method

PRIVATE

The fiftyone.core.dataset.Dataset field that stores the results cache for these runs.
fiftyone.core.runs.BaseRun.ensure_requirements

fiftyone.core.runs.BaseRun.html#ensure_requirements

Function

Method

PUBLIC

Ensures that any necessary packages to execute this run are installed.
fiftyone.core.runs.BaseRun.ensure_usage_requirements

fiftyone.core.runs.BaseRun.html#ensure_usage_requirements

Function

Method

PUBLIC

Ensures that any necessary packages to use existing results for this run are installed.
fiftyone.core.runs.BaseRun.get_fields

fiftyone.core.runs.BaseRun.html#get_fields

Function

Method

PUBLIC

Gets the fields that were involved in the given run.
fiftyone.core.runs.BaseRun.rename

fiftyone.core.runs.BaseRun.html#rename

Function

Method

PUBLIC

Performs any necessary operations required to rename this run's key.
fiftyone.core.runs.BaseRun.cleanup

fiftyone.core.runs.BaseRun.html#cleanup

Function

Method

PUBLIC

Cleans up the results of the run with the given key from the collection.
fiftyone.core.runs.BaseRun.register_run

fiftyone.core.runs.BaseRun.html#register_run

Function

Method

PUBLIC

Registers a run of this method under the given key on the given collection.
fiftyone.core.runs.BaseRun.validate_run

fiftyone.core.runs.BaseRun.html#validate_run

Function

Method

PUBLIC

Validates that the collection can accept this run.
fiftyone.core.runs.BaseRun._validate_run

fiftyone.core.runs.BaseRun.html#_validate_run

Function

Method

PRIVATE

Subclass-specific validation when a run with the given key already exists.
fiftyone.core.runs.BaseRun._validate_fields_match

fiftyone.core.runs.BaseRun.html#_validate_fields_match

Function

Method

PRIVATE

Undocumented
fiftyone.core.runs.BaseRun.list_runs

fiftyone.core.runs.BaseRun.html#list_runs

Function

Class Method

PUBLIC

Returns the list of run keys on the given collection.
fiftyone.core.runs.BaseRun.update_run_key

fiftyone.core.runs.BaseRun.html#update_run_key

Function

Class Method

PUBLIC

Replaces the key for the given run with a new key.
fiftyone.core.runs.BaseRun.get_run_info

fiftyone.core.runs.BaseRun.html#get_run_info

Function

Class Method

PUBLIC

Gets the BaseRunInfo for the given key on the collection.
fiftyone.core.runs.BaseRun.save_run_info

fiftyone.core.runs.BaseRun.html#save_run_info

Function

Class Method

PUBLIC

Saves the run information on the collection.
fiftyone.core.runs.BaseRun.update_run_config

fiftyone.core.runs.BaseRun.html#update_run_config

Function

Class Method

PUBLIC

Updates the BaseRunConfig for the given run on the collection.
fiftyone.core.runs.BaseRun.save_run_results

fiftyone.core.runs.BaseRun.html#save_run_results

Function

Class Method

PUBLIC

Saves the run results on the collection.
fiftyone.core.runs.BaseRun.load_run_results

fiftyone.core.runs.BaseRun.html#load_run_results

Function

Class Method

PUBLIC

Loads the BaseRunResults for the given key on the collection.
fiftyone.core.runs.BaseRun.has_cached_run_results

fiftyone.core.runs.BaseRun.html#has_cached_run_results

Function

Class Method

PUBLIC

Determines whether BaseRunResults for the given key are cached on the collection.
fiftyone.core.runs.BaseRun.load_run_view

fiftyone.core.runs.BaseRun.html#load_run_view

Function

Class Method

PUBLIC

Loads the fiftyone.core.view.DatasetView on which the specified run was performed.
fiftyone.core.runs.BaseRun.delete_run

fiftyone.core.runs.BaseRun.html#delete_run

Function

Class Method

PUBLIC

Deletes the results associated with the given run key from the collection.
fiftyone.core.runs.BaseRun.delete_runs

fiftyone.core.runs.BaseRun.html#delete_runs

Function

Class Method

PUBLIC

Deletes all runs from the collection.
fiftyone.core.runs.BaseRun._get_run_docs

fiftyone.core.runs.BaseRun.html#_get_run_docs

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.runs.BaseRun._get_run_doc

fiftyone.core.runs.BaseRun.html#_get_run_doc

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.runs.BaseRun._get_run_fields

fiftyone.core.runs.BaseRun.html#_get_run_fields

Function

Class Method

PRIVATE

Undocumented
fiftyone.core.runs.BaseRunResults

fiftyone.core.runs.BaseRunResults.html

Class

Class

PUBLIC

Base class for storing the results of a run.
fiftyone.core.runs.BaseRunResults.__init__

fiftyone.core.runs.BaseRunResults.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.runs.BaseRunResults._samples

fiftyone.core.runs.BaseRunResults.html#_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.runs.BaseRunResults._config

fiftyone.core.runs.BaseRunResults.html#_config

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.runs.BaseRunResults._backend

fiftyone.core.runs.BaseRunResults.html#_backend

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.runs.BaseRunResults._key

fiftyone.core.runs.BaseRunResults.html#_key

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.runs.BaseRunResults.cls

fiftyone.core.runs.BaseRunResults.html#cls

Attribute

Property

PUBLIC

The fully-qualified name of this BaseRunResults class.
fiftyone.core.runs.BaseRunResults.samples

fiftyone.core.runs.BaseRunResults.html#samples

Attribute

Property

PUBLIC

The fiftyone.core.collections.SampleCollection associated with these results.
fiftyone.core.runs.BaseRunResults.config

fiftyone.core.runs.BaseRunResults.html#config

Attribute

Property

PUBLIC

The BaseRunConfig for these results.
fiftyone.core.runs.BaseRunResults.backend

fiftyone.core.runs.BaseRunResults.html#backend

Attribute

Property

PUBLIC

The BaseRun for these results.
fiftyone.core.runs.BaseRunResults.key

fiftyone.core.runs.BaseRunResults.html#key

Attribute

Property

PUBLIC

The run key for these results.
fiftyone.core.runs.BaseRunResults.save

fiftyone.core.runs.BaseRunResults.html#save

Function

Method

PUBLIC

Saves the results to the database.
fiftyone.core.runs.BaseRunResults.save_config

fiftyone.core.runs.BaseRunResults.html#save_config

Function

Method

PUBLIC

Saves these results config to the database.
fiftyone.core.runs.BaseRunResults.attributes

fiftyone.core.runs.BaseRunResults.html#attributes

Function

Method

PUBLIC

Returns the list of class attributes that will be serialized by serialize.
fiftyone.core.runs.BaseRunResults.from_dict

fiftyone.core.runs.BaseRunResults.html#from_dict

Function

Class Method

PUBLIC

Builds a BaseRunResults from a JSON dict representation of it.
fiftyone.core.runs.BaseRunResults._from_dict

fiftyone.core.runs.BaseRunResults.html#_from_dict

Function

Class Method

PRIVATE

Subclass implementation of from_dict.
fiftyone.core.runs.BaseRunResults.base_results_cls

fiftyone.core.runs.BaseRunResults.html#base_results_cls

Function

Static Method

PUBLIC

Returns the results class for the given run type.
fiftyone.core.runs.RunInfo

fiftyone.core.runs.RunInfo.html

Class

Class

PUBLIC

Information about a run on a dataset.
fiftyone.core.runs.RunInfo.config_cls

fiftyone.core.runs.RunInfo.html#config_cls

Function

Class Method

PUBLIC

The BaseRunConfig class associated with this class.
fiftyone.core.runs.RunConfig

fiftyone.core.runs.RunConfig.html

Class

Class

PUBLIC

Class for configuring Run instances.
fiftyone.core.runs.RunConfig.__init__

fiftyone.core.runs.RunConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.runs.RunConfig._method

fiftyone.core.runs.RunConfig.html#_method

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.runs.RunConfig.type

fiftyone.core.runs.RunConfig.html#type

Attribute

Property

PUBLIC

The type of run.
fiftyone.core.runs.RunConfig.method

fiftyone.core.runs.RunConfig.html#method

Attribute

Property

PUBLIC

The name of the method.
fiftyone.core.runs.RunConfig.method.setter

fiftyone.core.runs.RunConfig.html#method.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.runs.RunConfig._virtual_attributes

fiftyone.core.runs.RunConfig.html#_virtual_attributes

Function

Class Method

PRIVATE

A list of attributes that are serialized but should not be treated as parameters when loading the config class from the database.
fiftyone.core.runs.Run

fiftyone.core.runs.Run.html

Class

Class

PUBLIC

Class for runs.
fiftyone.core.runs.Run.run_info_cls

fiftyone.core.runs.Run.html#run_info_cls

Function

Class Method

PUBLIC

The BaseRunInfo class associated with this class.
fiftyone.core.runs.Run._runs_field

fiftyone.core.runs.Run.html#_runs_field

Function

Class Method

PRIVATE

The fiftyone.core.odm.dataset.DatasetDocument field in which these runs are stored.
fiftyone.core.runs.Run._run_str

fiftyone.core.runs.Run.html#_run_str

Function

Class Method

PRIVATE

A string to use when referring to these runs in log messages.
fiftyone.core.runs.Run._results_cache_field

fiftyone.core.runs.Run.html#_results_cache_field

Function

Class Method

PRIVATE

The fiftyone.core.dataset.Dataset field that stores the results cache for these runs.
fiftyone.core.runs.Run._patch_function

fiftyone.core.runs.Run.html#_patch_function

Function

Class Method

PRIVATE

A function that can patch any ReferenceField issues with a dataset's runs.
fiftyone.core.runs.RunResults

fiftyone.core.runs.RunResults.html

Class

Class

PUBLIC

Class for run results.
fiftyone.core.runs.RunResults.__init__

fiftyone.core.runs.RunResults.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.runs.RunResults._from_dict

fiftyone.core.runs.RunResults.html#_from_dict

Function

Class Method

PRIVATE

Subclass implementation of from_dict.
fiftyone.core.sample.get_default_sample_fields

fiftyone.core.sample.html#get_default_sample_fields

Function

Function

PUBLIC

Returns the default fields present on all samples.
fiftyone.core.sample._SampleMixin

fiftyone.core.sample._SampleMixin.html

Class

Class

PRIVATE

No class docstring; 2/4 properties, 5/15 methods documented
fiftyone.core.sample._SampleMixin.__getattr__

fiftyone.core.sample._SampleMixin.html#__getattr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.sample._SampleMixin.__setattr__

fiftyone.core.sample._SampleMixin.html#__setattr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.sample._SampleMixin.__getitem__

fiftyone.core.sample._SampleMixin.html#__getitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.sample._SampleMixin.__setitem__

fiftyone.core.sample._SampleMixin.html#__setitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.sample._SampleMixin.__iter__

fiftyone.core.sample._SampleMixin.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.core.sample._SampleMixin.dataset_id

fiftyone.core.sample._SampleMixin.html#dataset_id

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.sample._SampleMixin._dataset_id

fiftyone.core.sample._SampleMixin.html#_dataset_id

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.sample._SampleMixin.filename

fiftyone.core.sample._SampleMixin.html#filename

Attribute

Property

PUBLIC

The basename of the media's filepath.
fiftyone.core.sample._SampleMixin.media_type

fiftyone.core.sample._SampleMixin.html#media_type

Attribute

Property

PUBLIC

The media type of the sample.
fiftyone.core.sample._SampleMixin.get_field

fiftyone.core.sample._SampleMixin.html#get_field

Function

Method

PUBLIC

Undocumented
fiftyone.core.sample._SampleMixin.set_field

fiftyone.core.sample._SampleMixin.html#set_field

Function

Method

PUBLIC

Undocumented
fiftyone.core.sample._SampleMixin.clear_field

fiftyone.core.sample._SampleMixin.html#clear_field

Function

Method

PUBLIC

Undocumented
fiftyone.core.sample._SampleMixin.compute_metadata

fiftyone.core.sample._SampleMixin.html#compute_metadata

Function

Method

PUBLIC

Populates the metadata field of the sample.
fiftyone.core.sample._SampleMixin.add_labels

fiftyone.core.sample._SampleMixin.html#add_labels

Function

Method

PUBLIC

Adds the given labels to the sample.
fiftyone.core.sample._SampleMixin.merge

fiftyone.core.sample._SampleMixin.html#merge

Function

Method

PUBLIC

Merges the fields of the given sample into this sample.
fiftyone.core.sample._SampleMixin.copy

fiftyone.core.sample._SampleMixin.html#copy

Function

Method

PUBLIC

Returns a deep copy of the sample that has not been added to the database.
fiftyone.core.sample._SampleMixin.to_dict

fiftyone.core.sample._SampleMixin.html#to_dict

Function

Method

PUBLIC

Serializes the sample to a JSON dictionary.
fiftyone.core.sample._SampleMixin._secure_media

fiftyone.core.sample._SampleMixin.html#_secure_media

Function

Method

PRIVATE

Undocumented
fiftyone.core.sample._SampleMixin._parse_fields_video

fiftyone.core.sample._SampleMixin.html#_parse_fields_video

Function

Method

PRIVATE

Undocumented
fiftyone.core.sample.Sample

fiftyone.core.sample.Sample.html

Class

Class

PUBLIC

A sample in a fiftyone.core.dataset.Dataset.
fiftyone.core.sample.Sample.__init__

fiftyone.core.sample.Sample.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.sample.Sample._frames

fiftyone.core.sample.Sample.html#_frames

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.sample.Sample.__repr__

fiftyone.core.sample.Sample.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.sample.Sample._reload_backing_doc

fiftyone.core.sample.Sample.html#_reload_backing_doc

Function

Method

PRIVATE

Reloads the backing doc from the database.
fiftyone.core.sample.Sample._doc

fiftyone.core.sample.Sample.html#_doc

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.sample.Sample.reload

fiftyone.core.sample.Sample.html#reload

Function

Method

PUBLIC

Reloads the sample from the database.
fiftyone.core.sample.Sample.save

fiftyone.core.sample.Sample.html#save

Function

Method

PUBLIC

Saves the sample to the database.
fiftyone.core.sample.Sample._save

fiftyone.core.sample.Sample.html#_save

Function

Method

PRIVATE

Undocumented
fiftyone.core.sample.Sample.from_frame

fiftyone.core.sample.Sample.html#from_frame

Function

Class Method

PUBLIC

Creates a sample from the given frame.
fiftyone.core.sample.Sample.from_doc

fiftyone.core.sample.Sample.html#from_doc

Function

Class Method

PUBLIC

Creates a sample backed by the given document.
fiftyone.core.sample.Sample.from_dict

fiftyone.core.sample.Sample.html#from_dict

Function

Class Method

PUBLIC

Loads the sample from a JSON dictionary.
fiftyone.core.sample.SampleView

fiftyone.core.sample.SampleView.html

Class

Class

PUBLIC

A view into a Sample in a dataset.
fiftyone.core.sample.SampleView.__init__

fiftyone.core.sample.SampleView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.sample.SampleView._frames

fiftyone.core.sample.SampleView.html#_frames

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.sample.SampleView.__repr__

fiftyone.core.sample.SampleView.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.sample.SampleView.to_dict

fiftyone.core.sample.SampleView.html#to_dict

Function

Method

PUBLIC

Serializes the sample view to a JSON dictionary.
fiftyone.core.sample.SampleView.save

fiftyone.core.sample.SampleView.html#save

Function

Method

PUBLIC

Saves the sample view to the database.
fiftyone.core.sample.SampleView._save

fiftyone.core.sample.SampleView.html#_save

Function

Method

PRIVATE

Undocumented
fiftyone.core.sample._apply_confidence_thresh

fiftyone.core.sample.html#_apply_confidence_thresh

Function

Function

PRIVATE

Undocumented
fiftyone.core.sample._is_frames_dict

fiftyone.core.sample.html#_is_frames_dict

Function

Function

PRIVATE

Undocumented
fiftyone.core.threed.validators.validate_bool

fiftyone.core.threed.validators.html#validate_bool

Function

Function

PUBLIC

Undocumented
fiftyone.core.threed.validators.validate_choice

fiftyone.core.threed.validators.html#validate_choice

Function

Function

PUBLIC

Undocumented
fiftyone.core.threed.validators.validate_color

fiftyone.core.threed.validators.html#validate_color

Function

Function

PUBLIC

Undocumented
fiftyone.core.threed.validators.validate_float

fiftyone.core.threed.validators.html#validate_float

Function

Function

PUBLIC

Undocumented
fiftyone.core.threed.validators.validate_list

fiftyone.core.threed.validators.html#validate_list

Function

Function

PUBLIC

Undocumented
fiftyone.core.threed.validators.BaseValidatedDataClass

fiftyone.core.threed.validators.BaseValidatedDataClass.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.threed.validators.BaseValidatedDataClass.__eq__

fiftyone.core.threed.validators.BaseValidatedDataClass.html#__eq__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.validators.BaseValidatedDataClass.__setattr__

fiftyone.core.threed.validators.BaseValidatedDataClass.html#__setattr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.validators.BaseValidatedDataClass.__repr__

fiftyone.core.threed.validators.BaseValidatedDataClass.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.transformation.EULER_AXES_SEQUENCES

fiftyone.core.threed.transformation.html#EULER_AXES_SEQUENCES

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.threed.transformation.EulerAxesSequence

fiftyone.core.threed.transformation.html#EulerAxesSequence

Attribute

Type Alias

PUBLIC

Undocumented
fiftyone.core.threed.transformation.Vector3

fiftyone.core.threed.transformation.Vector3.html

Class

Class

PUBLIC

Represents a three-dimensional vector.
fiftyone.core.threed.transformation.Vector3.__init__

fiftyone.core.threed.transformation.Vector3.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.transformation.Vector3._x

fiftyone.core.threed.transformation.Vector3.html#_x

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.transformation.Vector3._y

fiftyone.core.threed.transformation.Vector3.html#_y

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.transformation.Vector3._z

fiftyone.core.threed.transformation.Vector3.html#_z

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.transformation.Vector3.x

fiftyone.core.threed.transformation.Vector3.html#x

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.transformation.Vector3.y

fiftyone.core.threed.transformation.Vector3.html#y

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.transformation.Vector3.z

fiftyone.core.threed.transformation.Vector3.html#z

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.transformation.Vector3.to_arr

fiftyone.core.threed.transformation.Vector3.html#to_arr

Function

Method

PUBLIC

Converts the vector to a numpy array.
fiftyone.core.threed.transformation.Euler

fiftyone.core.threed.transformation.Euler.html

Class

Class

PUBLIC

Represents intrinsic rotations about the object's own principal axes.
fiftyone.core.threed.transformation.Euler.__init__

fiftyone.core.threed.transformation.Euler.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.transformation.Euler._degrees

fiftyone.core.threed.transformation.Euler.html#_degrees

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.transformation.Euler._sequence

fiftyone.core.threed.transformation.Euler.html#_sequence

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.transformation.Euler.degrees

fiftyone.core.threed.transformation.Euler.html#degrees

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.transformation.Euler.sequence

fiftyone.core.threed.transformation.Euler.html#sequence

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.transformation.Euler.to_quaternion

fiftyone.core.threed.transformation.Euler.html#to_quaternion

Function

Method

PUBLIC

Converts the euler angles to a quaternion.
fiftyone.core.threed.transformation.Quaternion

fiftyone.core.threed.transformation.Quaternion.html

Class

Class

PUBLIC

Represents a quaternion.
fiftyone.core.threed.transformation.Quaternion.__init__

fiftyone.core.threed.transformation.Quaternion.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.transformation.Quaternion._x

fiftyone.core.threed.transformation.Quaternion.html#_x

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.transformation.Quaternion._y

fiftyone.core.threed.transformation.Quaternion.html#_y

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.transformation.Quaternion._z

fiftyone.core.threed.transformation.Quaternion.html#_z

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.transformation.Quaternion._w

fiftyone.core.threed.transformation.Quaternion.html#_w

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.transformation.Quaternion.x

fiftyone.core.threed.transformation.Quaternion.html#x

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.transformation.Quaternion.y

fiftyone.core.threed.transformation.Quaternion.html#y

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.transformation.Quaternion.z

fiftyone.core.threed.transformation.Quaternion.html#z

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.transformation.Quaternion.w

fiftyone.core.threed.transformation.Quaternion.html#w

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.transformation.Quaternion.to_euler

fiftyone.core.threed.transformation.Quaternion.html#to_euler

Function

Method

PUBLIC

Converts the quaternion into euler angles.
fiftyone.core.threed.transformation.Quaternion.to_arr

fiftyone.core.threed.transformation.Quaternion.html#to_arr

Function

Method

PUBLIC

Converts the quaternion to a numpy array.
fiftyone.core.threed.transformation.Vec3UnionType

fiftyone.core.threed.transformation.html#Vec3UnionType

Attribute

Type Alias

PUBLIC

Undocumented
fiftyone.core.threed.transformation.normalize_to_vec3

fiftyone.core.threed.transformation.html#normalize_to_vec3

Function

Function

PUBLIC

Undocumented
fiftyone.core.threed.transformation.coerce_to_vec3

fiftyone.core.threed.transformation.html#coerce_to_vec3

Function

Function

PUBLIC

Undocumented
fiftyone.core.threed.utils.FO3D_VERSION_KEY

fiftyone.core.threed.utils.html#FO3D_VERSION_KEY

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.threed.utils.camel_to_snake

fiftyone.core.threed.utils.html#camel_to_snake

Function

Function

PUBLIC

Convert camelCase to snake_case.
fiftyone.core.threed.utils.convert_keys_to_snake_case

fiftyone.core.threed.utils.html#convert_keys_to_snake_case

Function

Function

PUBLIC

Convert all keys in a dictionary from camelCase to snake_case.
fiftyone.core.threed.object_3d.threed

fiftyone.core.threed.object_3d.html#threed

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.threed.object_3d.Object3D

fiftyone.core.threed.object_3d.Object3D.html

Class

Class

PUBLIC

The base class for all 3D objects in the scene.
fiftyone.core.threed.object_3d.Object3D.visible

fiftyone.core.threed.object_3d.Object3D.html#visible

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.object_3d.Object3D._asset_path_fields

fiftyone.core.threed.object_3d.Object3D.html#_asset_path_fields

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.threed.object_3d.Object3D.__init__

fiftyone.core.threed.object_3d.Object3D.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.object_3d.Object3D.name

fiftyone.core.threed.object_3d.Object3D.html#name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.object_3d.Object3D._position

fiftyone.core.threed.object_3d.Object3D.html#_position

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.object_3d.Object3D._scale

fiftyone.core.threed.object_3d.Object3D.html#_scale

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.object_3d.Object3D._quaternion

fiftyone.core.threed.object_3d.Object3D.html#_quaternion

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.object_3d.Object3D._rotation

fiftyone.core.threed.object_3d.Object3D.html#_rotation

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.object_3d.Object3D._local_transform_matrix

fiftyone.core.threed.object_3d.Object3D.html#_local_transform_matrix

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.object_3d.Object3D._uuid

fiftyone.core.threed.object_3d.Object3D.html#_uuid

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.object_3d.Object3D.children

fiftyone.core.threed.object_3d.Object3D.html#children

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.object_3d.Object3D.__repr__

fiftyone.core.threed.object_3d.Object3D.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.object_3d.Object3D.__str__

fiftyone.core.threed.object_3d.Object3D.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.object_3d.Object3D.__eq__

fiftyone.core.threed.object_3d.Object3D.html#__eq__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.object_3d.Object3D.__iter__

fiftyone.core.threed.object_3d.Object3D.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.object_3d.Object3D.uuid

fiftyone.core.threed.object_3d.Object3D.html#uuid

Attribute

Property

PUBLIC

The unique ID of the object.
fiftyone.core.threed.object_3d.Object3D.position

fiftyone.core.threed.object_3d.Object3D.html#position

Attribute

Property

PUBLIC

The position of the object in object space.
fiftyone.core.threed.object_3d.Object3D.position.setter

fiftyone.core.threed.object_3d.Object3D.html#position.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.object_3d.Object3D.rotation

fiftyone.core.threed.object_3d.Object3D.html#rotation

Attribute

Property

PUBLIC

The rotation of the object in object space.
fiftyone.core.threed.object_3d.Object3D.rotation.setter

fiftyone.core.threed.object_3d.Object3D.html#rotation.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.object_3d.Object3D.quaternion

fiftyone.core.threed.object_3d.Object3D.html#quaternion

Attribute

Property

PUBLIC

The quaternion of the object in object space.
fiftyone.core.threed.object_3d.Object3D.quaternion.setter

fiftyone.core.threed.object_3d.Object3D.html#quaternion.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.object_3d.Object3D.scale

fiftyone.core.threed.object_3d.Object3D.html#scale

Attribute

Property

PUBLIC

The scale of the object in object space.
fiftyone.core.threed.object_3d.Object3D.scale.setter

fiftyone.core.threed.object_3d.Object3D.html#scale.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.object_3d.Object3D.local_transform_matrix

fiftyone.core.threed.object_3d.Object3D.html#local_transform_matrix

Attribute

Property

PUBLIC

The local transform matrix of the object.
fiftyone.core.threed.object_3d.Object3D.local_transform_matrix.setter

fiftyone.core.threed.object_3d.Object3D.html#local_transform_matrix.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.object_3d.Object3D._update_matrix

fiftyone.core.threed.object_3d.Object3D.html#_update_matrix

Function

Method

PRIVATE

Undocumented
fiftyone.core.threed.object_3d.Object3D.add

fiftyone.core.threed.object_3d.Object3D.html#add

Function

Method

PUBLIC

Add one or more objects as children of this one.
fiftyone.core.threed.object_3d.Object3D.clear

fiftyone.core.threed.object_3d.Object3D.html#clear

Function

Method

PUBLIC

Remove all children from this object.
fiftyone.core.threed.object_3d.Object3D._get_asset_paths

fiftyone.core.threed.object_3d.Object3D.html#_get_asset_paths

Function

Method

PRIVATE

Get asset paths for this node
fiftyone.core.threed.object_3d.Object3D.traverse

fiftyone.core.threed.object_3d.Object3D.html#traverse

Function

Method

PUBLIC

Traverse the scene graph.
fiftyone.core.threed.object_3d.Object3D.as_dict

fiftyone.core.threed.object_3d.Object3D.html#as_dict

Function

Method

PUBLIC

Converts the object to a dict.
fiftyone.core.threed.object_3d.Object3D._to_dict_extra

fiftyone.core.threed.object_3d.Object3D.html#_to_dict_extra

Function

Method

PRIVATE

Returns the extra data to include in the dict representation.
fiftyone.core.threed.object_3d.Object3D._from_dict

fiftyone.core.threed.object_3d.Object3D.html#_from_dict

Function

Static Method

PRIVATE

Creates an Object3D (or its subclass) from a dict.
fiftyone.core.threed.lights.COLOR_DEFAULT_WHITE

fiftyone.core.threed.lights.html#COLOR_DEFAULT_WHITE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.threed.lights.Light

fiftyone.core.threed.lights.Light.html

Class

Class

PUBLIC

Base class for 3D lights.
fiftyone.core.threed.lights.Light.color

fiftyone.core.threed.lights.Light.html#color

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.lights.Light.intensity

fiftyone.core.threed.lights.Light.html#intensity

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.lights.Light.__init__

fiftyone.core.threed.lights.Light.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.lights.Light._to_dict_extra

fiftyone.core.threed.lights.Light.html#_to_dict_extra

Function

Method

PRIVATE

Returns the extra data to include in the dict representation.
fiftyone.core.threed.lights.AmbientLight

fiftyone.core.threed.lights.AmbientLight.html

Class

Class

PUBLIC

Represents an ambient light.
fiftyone.core.threed.lights.AmbientLight.__init__

fiftyone.core.threed.lights.AmbientLight.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.lights.AmbientLight.__repr__

fiftyone.core.threed.lights.AmbientLight.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.lights.DirectionalLight

fiftyone.core.threed.lights.DirectionalLight.html

Class

Class

PUBLIC

Represents a directional light.
fiftyone.core.threed.lights.DirectionalLight.target

fiftyone.core.threed.lights.DirectionalLight.html#target

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.lights.DirectionalLight.__init__

fiftyone.core.threed.lights.DirectionalLight.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.lights.DirectionalLight.__repr__

fiftyone.core.threed.lights.DirectionalLight.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.lights.DirectionalLight._to_dict_extra

fiftyone.core.threed.lights.DirectionalLight.html#_to_dict_extra

Function

Method

PRIVATE

Returns the extra data to include in the dict representation.
fiftyone.core.threed.lights.PointLight

fiftyone.core.threed.lights.PointLight.html

Class

Class

PUBLIC

Represents a point light.
fiftyone.core.threed.lights.PointLight.distance

fiftyone.core.threed.lights.PointLight.html#distance

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.lights.PointLight.decay

fiftyone.core.threed.lights.PointLight.html#decay

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.lights.PointLight.__init__

fiftyone.core.threed.lights.PointLight.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.lights.PointLight.__repr__

fiftyone.core.threed.lights.PointLight.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.lights.PointLight._to_dict_extra

fiftyone.core.threed.lights.PointLight.html#_to_dict_extra

Function

Method

PRIVATE

Returns the extra data to include in the dict representation.
fiftyone.core.threed.lights.SpotLight

fiftyone.core.threed.lights.SpotLight.html

Class

Class

PUBLIC

Represents a spot light.
fiftyone.core.threed.lights.SpotLight.target

fiftyone.core.threed.lights.SpotLight.html#target

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.lights.SpotLight.distance

fiftyone.core.threed.lights.SpotLight.html#distance

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.lights.SpotLight.decay

fiftyone.core.threed.lights.SpotLight.html#decay

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.lights.SpotLight.angle

fiftyone.core.threed.lights.SpotLight.html#angle

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.lights.SpotLight.penumbra

fiftyone.core.threed.lights.SpotLight.html#penumbra

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.lights.SpotLight.__init__

fiftyone.core.threed.lights.SpotLight.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.lights.SpotLight.__repr__

fiftyone.core.threed.lights.SpotLight.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.lights.SpotLight._to_dict_extra

fiftyone.core.threed.lights.SpotLight.html#_to_dict_extra

Function

Method

PRIVATE

Returns the extra data to include in the dict representation.
fiftyone.core.threed.material_3d.threed

fiftyone.core.threed.material_3d.html#threed

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.COLOR_DEFAULT_GRAY

fiftyone.core.threed.material_3d.html#COLOR_DEFAULT_GRAY

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.COLOR_DEFAULT_DARK_GRAY

fiftyone.core.threed.material_3d.html#COLOR_DEFAULT_DARK_GRAY

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.COLOR_DEFAULT_WHITE

fiftyone.core.threed.material_3d.html#COLOR_DEFAULT_WHITE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.COLOR_DEFAULT_BLACK

fiftyone.core.threed.material_3d.html#COLOR_DEFAULT_BLACK

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.Material3D

fiftyone.core.threed.material_3d.Material3D.html

Class

Class

PUBLIC

Base class for 3D materials.
fiftyone.core.threed.material_3d.Material3D.__init__

fiftyone.core.threed.material_3d.Material3D.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.Material3D.opacity 0

fiftyone.core.threed.material_3d.Material3D.html#opacity%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.Material3D.opacity

fiftyone.core.threed.material_3d.Material3D.html#opacity

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.Material3D.opacity.setter

fiftyone.core.threed.material_3d.Material3D.html#opacity.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.Material3D._opacity

fiftyone.core.threed.material_3d.Material3D.html#_opacity

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.Material3D.as_dict

fiftyone.core.threed.material_3d.Material3D.html#as_dict

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.Material3D._from_dict

fiftyone.core.threed.material_3d.Material3D.html#_from_dict

Function

Static Method

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.SHADING_MODES

fiftyone.core.threed.material_3d.html#SHADING_MODES

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.ShadingMode

fiftyone.core.threed.material_3d.html#ShadingMode

Attribute

Type Alias

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial

fiftyone.core.threed.material_3d.PointCloudMaterial.html

Class

Class

PUBLIC

Represents a point cloud material.
fiftyone.core.threed.material_3d.PointCloudMaterial.__init__

fiftyone.core.threed.material_3d.PointCloudMaterial.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial.shading_mode 0

fiftyone.core.threed.material_3d.PointCloudMaterial.html#shading_mode%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial.shading_mode

fiftyone.core.threed.material_3d.PointCloudMaterial.html#shading_mode

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial.shading_mode.setter

fiftyone.core.threed.material_3d.PointCloudMaterial.html#shading_mode.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial._shading_mode

fiftyone.core.threed.material_3d.PointCloudMaterial.html#_shading_mode

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial.custom_color 0

fiftyone.core.threed.material_3d.PointCloudMaterial.html#custom_color%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial.custom_color

fiftyone.core.threed.material_3d.PointCloudMaterial.html#custom_color

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial.custom_color.setter

fiftyone.core.threed.material_3d.PointCloudMaterial.html#custom_color.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial._custom_color

fiftyone.core.threed.material_3d.PointCloudMaterial.html#_custom_color

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial.point_size 0

fiftyone.core.threed.material_3d.PointCloudMaterial.html#point_size%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial.point_size

fiftyone.core.threed.material_3d.PointCloudMaterial.html#point_size

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial.point_size.setter

fiftyone.core.threed.material_3d.PointCloudMaterial.html#point_size.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial._point_size

fiftyone.core.threed.material_3d.PointCloudMaterial.html#_point_size

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial.attenuate_by_distance 0

fiftyone.core.threed.material_3d.PointCloudMaterial.html#attenuate_by_distance%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial.attenuate_by_distance

fiftyone.core.threed.material_3d.PointCloudMaterial.html#attenuate_by_distance

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial.attenuate_by_distance.setter

fiftyone.core.threed.material_3d.PointCloudMaterial.html#attenuate_by_distance.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial._attenuate_by_distance

fiftyone.core.threed.material_3d.PointCloudMaterial.html#_attenuate_by_distance

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.PointCloudMaterial.as_dict

fiftyone.core.threed.material_3d.PointCloudMaterial.html#as_dict

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshMaterial

fiftyone.core.threed.material_3d.MeshMaterial.html

Class

Class

PUBLIC

Represents a mesh material.
fiftyone.core.threed.material_3d.MeshMaterial.__init__

fiftyone.core.threed.material_3d.MeshMaterial.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshMaterial.wireframe 0

fiftyone.core.threed.material_3d.MeshMaterial.html#wireframe%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshMaterial.wireframe

fiftyone.core.threed.material_3d.MeshMaterial.html#wireframe

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshMaterial.wireframe.setter

fiftyone.core.threed.material_3d.MeshMaterial.html#wireframe.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshMaterial._wireframe

fiftyone.core.threed.material_3d.MeshMaterial.html#_wireframe

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.MeshMaterial.as_dict

fiftyone.core.threed.material_3d.MeshMaterial.html#as_dict

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshBasicMaterial

fiftyone.core.threed.material_3d.MeshBasicMaterial.html

Class

Class

PUBLIC

Represents a basic mesh material.
fiftyone.core.threed.material_3d.MeshBasicMaterial.__init__

fiftyone.core.threed.material_3d.MeshBasicMaterial.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshBasicMaterial.color 0

fiftyone.core.threed.material_3d.MeshBasicMaterial.html#color%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshBasicMaterial.color

fiftyone.core.threed.material_3d.MeshBasicMaterial.html#color

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshBasicMaterial.color.setter

fiftyone.core.threed.material_3d.MeshBasicMaterial.html#color.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshBasicMaterial._color

fiftyone.core.threed.material_3d.MeshBasicMaterial.html#_color

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.MeshBasicMaterial.as_dict

fiftyone.core.threed.material_3d.MeshBasicMaterial.html#as_dict

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial

fiftyone.core.threed.material_3d.MeshStandardMaterial.html

Class

Class

PUBLIC

Represents a standard mesh material.
fiftyone.core.threed.material_3d.MeshStandardMaterial.__init__

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial.color 0

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#color%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial.color

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#color

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial.color.setter

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#color.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial._color

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#_color

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial.emissive_color 0

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#emissive_color%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial.emissive_color

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#emissive_color

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial.emissive_color.setter

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#emissive_color.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial._emissive_color

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#_emissive_color

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial.emissive_intensity 0

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#emissive_intensity%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial.emissive_intensity

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#emissive_intensity

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial.emissive_intensity.setter

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#emissive_intensity.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial._emissive_intensity

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#_emissive_intensity

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial.metalness 0

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#metalness%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial.metalness

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#metalness

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial.metalness.setter

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#metalness.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial._metalness

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#_metalness

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial.roughness 0

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#roughness%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial.roughness

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#roughness

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial.roughness.setter

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#roughness.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial._roughness

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#_roughness

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.MeshStandardMaterial.as_dict

fiftyone.core.threed.material_3d.MeshStandardMaterial.html#as_dict

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial

fiftyone.core.threed.material_3d.MeshLambertMaterial.html

Class

Class

PUBLIC

Represents a Lambert mesh material.
fiftyone.core.threed.material_3d.MeshLambertMaterial.__init__

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial.color 0

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#color%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial.color

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#color

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial.color.setter

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#color.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial._color

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#_color

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial.emissive_color 0

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#emissive_color%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial.emissive_color

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#emissive_color

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial.emissive_color.setter

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#emissive_color.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial._emissive_color

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#_emissive_color

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial.emissive_intensity 0

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#emissive_intensity%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial.emissive_intensity

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#emissive_intensity

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial.emissive_intensity.setter

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#emissive_intensity.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial._emissive_intensity

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#_emissive_intensity

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial.reflectivity 0

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#reflectivity%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial.reflectivity

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#reflectivity

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial.reflectivity.setter

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#reflectivity.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial._reflectivity

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#_reflectivity

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial.refraction_ratio 0

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#refraction_ratio%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial.refraction_ratio

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#refraction_ratio

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial.refraction_ratio.setter

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#refraction_ratio.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial._refraction_ratio

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#_refraction_ratio

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.MeshLambertMaterial.as_dict

fiftyone.core.threed.material_3d.MeshLambertMaterial.html#as_dict

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshPhongMaterial

fiftyone.core.threed.material_3d.MeshPhongMaterial.html

Class

Class

PUBLIC

Represents a Phong mesh material.
fiftyone.core.threed.material_3d.MeshPhongMaterial.__init__

fiftyone.core.threed.material_3d.MeshPhongMaterial.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshPhongMaterial.shininess 0

fiftyone.core.threed.material_3d.MeshPhongMaterial.html#shininess%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshPhongMaterial.shininess

fiftyone.core.threed.material_3d.MeshPhongMaterial.html#shininess

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshPhongMaterial.shininess.setter

fiftyone.core.threed.material_3d.MeshPhongMaterial.html#shininess.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshPhongMaterial._shininess

fiftyone.core.threed.material_3d.MeshPhongMaterial.html#_shininess

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.MeshPhongMaterial.specular_color 0

fiftyone.core.threed.material_3d.MeshPhongMaterial.html#specular_color%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshPhongMaterial.specular_color

fiftyone.core.threed.material_3d.MeshPhongMaterial.html#specular_color

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshPhongMaterial.specular_color.setter

fiftyone.core.threed.material_3d.MeshPhongMaterial.html#specular_color.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshPhongMaterial._specular_color

fiftyone.core.threed.material_3d.MeshPhongMaterial.html#_specular_color

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.material_3d.MeshPhongMaterial.as_dict

fiftyone.core.threed.material_3d.MeshPhongMaterial.html#as_dict

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.material_3d.MeshDepthMaterial

fiftyone.core.threed.material_3d.MeshDepthMaterial.html

Class

Class

PUBLIC

Represents a depth mesh material.
fiftyone.core.threed.mesh.Mesh

fiftyone.core.threed.mesh.Mesh.html

Class

Class

PUBLIC

Represents an abstract 3D mesh.
fiftyone.core.threed.mesh.Mesh.__init__

fiftyone.core.threed.mesh.Mesh.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.mesh.Mesh.default_material

fiftyone.core.threed.mesh.Mesh.html#default_material

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.mesh.Mesh.set_default_material

fiftyone.core.threed.mesh.Mesh.html#set_default_material

Function

Method

PUBLIC

Sets the material of the mesh.
fiftyone.core.threed.mesh.Mesh._to_dict_extra

fiftyone.core.threed.mesh.Mesh.html#_to_dict_extra

Function

Method

PRIVATE

Returns the extra data to include in the dict representation.
fiftyone.core.threed.mesh.ObjMesh

fiftyone.core.threed.mesh.ObjMesh.html

Class

Class

PUBLIC

Represents an OBJ mesh.
fiftyone.core.threed.mesh.ObjMesh.obj_path

fiftyone.core.threed.mesh.ObjMesh.html#obj_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.mesh.ObjMesh.mtl_path

fiftyone.core.threed.mesh.ObjMesh.html#mtl_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.mesh.ObjMesh._asset_path_fields

fiftyone.core.threed.mesh.ObjMesh.html#_asset_path_fields

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.threed.mesh.ObjMesh.__init__

fiftyone.core.threed.mesh.ObjMesh.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.mesh.ObjMesh._to_dict_extra

fiftyone.core.threed.mesh.ObjMesh.html#_to_dict_extra

Function

Method

PRIVATE

Returns the extra data to include in the dict representation.
fiftyone.core.threed.mesh.FbxMesh

fiftyone.core.threed.mesh.FbxMesh.html

Class

Class

PUBLIC

Represents an FBX mesh.
fiftyone.core.threed.mesh.FbxMesh.fbx_path

fiftyone.core.threed.mesh.FbxMesh.html#fbx_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.mesh.FbxMesh._asset_path_fields

fiftyone.core.threed.mesh.FbxMesh.html#_asset_path_fields

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.threed.mesh.FbxMesh.__init__

fiftyone.core.threed.mesh.FbxMesh.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.mesh.FbxMesh._to_dict_extra

fiftyone.core.threed.mesh.FbxMesh.html#_to_dict_extra

Function

Method

PRIVATE

Returns the extra data to include in the dict representation.
fiftyone.core.threed.mesh.GltfMesh

fiftyone.core.threed.mesh.GltfMesh.html

Class

Class

PUBLIC

Represents a gLTF mesh.
fiftyone.core.threed.mesh.GltfMesh.gltf_path

fiftyone.core.threed.mesh.GltfMesh.html#gltf_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.mesh.GltfMesh._asset_path_fields

fiftyone.core.threed.mesh.GltfMesh.html#_asset_path_fields

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.threed.mesh.GltfMesh.__init__

fiftyone.core.threed.mesh.GltfMesh.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.mesh.GltfMesh._to_dict_extra

fiftyone.core.threed.mesh.GltfMesh.html#_to_dict_extra

Function

Method

PRIVATE

Returns the extra data to include in the dict representation.
fiftyone.core.threed.mesh.PlyMesh

fiftyone.core.threed.mesh.PlyMesh.html

Class

Class

PUBLIC

Represents a PLY mesh. A PLY mesh can be a point cloud or a mesh.
fiftyone.core.threed.mesh.PlyMesh.ply_path

fiftyone.core.threed.mesh.PlyMesh.html#ply_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.mesh.PlyMesh.is_point_cloud

fiftyone.core.threed.mesh.PlyMesh.html#is_point_cloud

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.mesh.PlyMesh.center_geometry

fiftyone.core.threed.mesh.PlyMesh.html#center_geometry

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.mesh.PlyMesh._asset_path_fields

fiftyone.core.threed.mesh.PlyMesh.html#_asset_path_fields

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.threed.mesh.PlyMesh.__init__

fiftyone.core.threed.mesh.PlyMesh.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.mesh.PlyMesh._to_dict_extra

fiftyone.core.threed.mesh.PlyMesh.html#_to_dict_extra

Function

Method

PRIVATE

Returns the extra data to include in the dict representation.
fiftyone.core.threed.mesh.StlMesh

fiftyone.core.threed.mesh.StlMesh.html

Class

Class

PUBLIC

Represents an STL mesh.
fiftyone.core.threed.mesh.StlMesh.stl_path

fiftyone.core.threed.mesh.StlMesh.html#stl_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.mesh.StlMesh._asset_path_fields

fiftyone.core.threed.mesh.StlMesh.html#_asset_path_fields

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.threed.mesh.StlMesh.__init__

fiftyone.core.threed.mesh.StlMesh.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.mesh.StlMesh._to_dict_extra

fiftyone.core.threed.mesh.StlMesh.html#_to_dict_extra

Function

Method

PRIVATE

Returns the extra data to include in the dict representation.
fiftyone.core.threed.pointcloud.PointCloud

fiftyone.core.threed.pointcloud.PointCloud.html

Class

Class

PUBLIC

Represents a point cloud.
fiftyone.core.threed.pointcloud.PointCloud.pcd_path

fiftyone.core.threed.pointcloud.PointCloud.html#pcd_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.pointcloud.PointCloud.center_geometry

fiftyone.core.threed.pointcloud.PointCloud.html#center_geometry

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.pointcloud.PointCloud.flag_for_projection

fiftyone.core.threed.pointcloud.PointCloud.html#flag_for_projection

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.pointcloud.PointCloud._asset_path_fields

fiftyone.core.threed.pointcloud.PointCloud.html#_asset_path_fields

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.core.threed.pointcloud.PointCloud.__init__

fiftyone.core.threed.pointcloud.PointCloud.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.pointcloud.PointCloud.default_material

fiftyone.core.threed.pointcloud.PointCloud.html#default_material

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.pointcloud.PointCloud.set_default_material

fiftyone.core.threed.pointcloud.PointCloud.html#set_default_material

Function

Method

PUBLIC

Sets the material of the point cloud.
fiftyone.core.threed.pointcloud.PointCloud._to_dict_extra

fiftyone.core.threed.pointcloud.PointCloud.html#_to_dict_extra

Function

Method

PRIVATE

Extra properties to include in dictionary representation.
fiftyone.core.threed.camera.UP_DIRECTIONS

fiftyone.core.threed.camera.html#UP_DIRECTIONS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.threed.camera.UpDirection

fiftyone.core.threed.camera.html#UpDirection

Attribute

Type Alias

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera

fiftyone.core.threed.camera.PerspectiveCamera.html

Class

Class

PUBLIC

Represents the configuration of a 3D perspective camera.
fiftyone.core.threed.camera.PerspectiveCamera.__init__

fiftyone.core.threed.camera.PerspectiveCamera.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.position 0

fiftyone.core.threed.camera.PerspectiveCamera.html#position%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.position

fiftyone.core.threed.camera.PerspectiveCamera.html#position

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.position.setter

fiftyone.core.threed.camera.PerspectiveCamera.html#position.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera._position

fiftyone.core.threed.camera.PerspectiveCamera.html#_position

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.look_at 0

fiftyone.core.threed.camera.PerspectiveCamera.html#look_at%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.look_at

fiftyone.core.threed.camera.PerspectiveCamera.html#look_at

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.look_at.setter

fiftyone.core.threed.camera.PerspectiveCamera.html#look_at.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera._look_at

fiftyone.core.threed.camera.PerspectiveCamera.html#_look_at

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.up 0

fiftyone.core.threed.camera.PerspectiveCamera.html#up%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.up

fiftyone.core.threed.camera.PerspectiveCamera.html#up

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.up.setter

fiftyone.core.threed.camera.PerspectiveCamera.html#up.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera._up

fiftyone.core.threed.camera.PerspectiveCamera.html#_up

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.aspect 0

fiftyone.core.threed.camera.PerspectiveCamera.html#aspect%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.aspect

fiftyone.core.threed.camera.PerspectiveCamera.html#aspect

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.aspect.setter

fiftyone.core.threed.camera.PerspectiveCamera.html#aspect.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera._aspect

fiftyone.core.threed.camera.PerspectiveCamera.html#_aspect

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.fov 0

fiftyone.core.threed.camera.PerspectiveCamera.html#fov%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.fov

fiftyone.core.threed.camera.PerspectiveCamera.html#fov

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.fov.setter

fiftyone.core.threed.camera.PerspectiveCamera.html#fov.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera._fov

fiftyone.core.threed.camera.PerspectiveCamera.html#_fov

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.near 0

fiftyone.core.threed.camera.PerspectiveCamera.html#near%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.near

fiftyone.core.threed.camera.PerspectiveCamera.html#near

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.near.setter

fiftyone.core.threed.camera.PerspectiveCamera.html#near.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera._near

fiftyone.core.threed.camera.PerspectiveCamera.html#_near

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.far 0

fiftyone.core.threed.camera.PerspectiveCamera.html#far%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.far

fiftyone.core.threed.camera.PerspectiveCamera.html#far

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.far.setter

fiftyone.core.threed.camera.PerspectiveCamera.html#far.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera._far

fiftyone.core.threed.camera.PerspectiveCamera.html#_far

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera.as_dict

fiftyone.core.threed.camera.PerspectiveCamera.html#as_dict

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.camera.PerspectiveCamera._from_dict

fiftyone.core.threed.camera.PerspectiveCamera.html#_from_dict

Function

Static Method

PRIVATE

Undocumented
fiftyone.core.threed.shape_3d.Shape3D

fiftyone.core.threed.shape_3d.Shape3D.html

Class

Class

PUBLIC

Represents an abstract 3D shape.
fiftyone.core.threed.shape_3d.BoxGeometry

fiftyone.core.threed.shape_3d.BoxGeometry.html

Class

Class

PUBLIC

Represents a 3D box.
fiftyone.core.threed.shape_3d.BoxGeometry.width

fiftyone.core.threed.shape_3d.BoxGeometry.html#width

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.BoxGeometry.height

fiftyone.core.threed.shape_3d.BoxGeometry.html#height

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.BoxGeometry.depth

fiftyone.core.threed.shape_3d.BoxGeometry.html#depth

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.BoxGeometry.__init__

fiftyone.core.threed.shape_3d.BoxGeometry.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.BoxGeometry._to_dict_extra

fiftyone.core.threed.shape_3d.BoxGeometry.html#_to_dict_extra

Function

Method

PRIVATE

Returns the extra data to include in the dict representation.
fiftyone.core.threed.shape_3d.CylinderGeometry

fiftyone.core.threed.shape_3d.CylinderGeometry.html

Class

Class

PUBLIC

Represents a 3D cylinder.
fiftyone.core.threed.shape_3d.CylinderGeometry.radius_top

fiftyone.core.threed.shape_3d.CylinderGeometry.html#radius_top

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.CylinderGeometry.radius_bottom

fiftyone.core.threed.shape_3d.CylinderGeometry.html#radius_bottom

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.CylinderGeometry.height

fiftyone.core.threed.shape_3d.CylinderGeometry.html#height

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.CylinderGeometry.radial_segments

fiftyone.core.threed.shape_3d.CylinderGeometry.html#radial_segments

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.CylinderGeometry.height_segments

fiftyone.core.threed.shape_3d.CylinderGeometry.html#height_segments

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.CylinderGeometry.open_ended

fiftyone.core.threed.shape_3d.CylinderGeometry.html#open_ended

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.CylinderGeometry.theta_start

fiftyone.core.threed.shape_3d.CylinderGeometry.html#theta_start

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.CylinderGeometry.theta_length

fiftyone.core.threed.shape_3d.CylinderGeometry.html#theta_length

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.CylinderGeometry.__init__

fiftyone.core.threed.shape_3d.CylinderGeometry.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.CylinderGeometry._to_dict_extra

fiftyone.core.threed.shape_3d.CylinderGeometry.html#_to_dict_extra

Function

Method

PRIVATE

Returns the extra data to include in the dict representation.
fiftyone.core.threed.shape_3d.SphereGeometry

fiftyone.core.threed.shape_3d.SphereGeometry.html

Class

Class

PUBLIC

Represents a 3D sphere.
fiftyone.core.threed.shape_3d.SphereGeometry.radius

fiftyone.core.threed.shape_3d.SphereGeometry.html#radius

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.SphereGeometry.width_segments

fiftyone.core.threed.shape_3d.SphereGeometry.html#width_segments

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.SphereGeometry.height_segments

fiftyone.core.threed.shape_3d.SphereGeometry.html#height_segments

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.SphereGeometry.phi_start

fiftyone.core.threed.shape_3d.SphereGeometry.html#phi_start

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.SphereGeometry.phi_length

fiftyone.core.threed.shape_3d.SphereGeometry.html#phi_length

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.SphereGeometry.theta_start

fiftyone.core.threed.shape_3d.SphereGeometry.html#theta_start

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.SphereGeometry.theta_length

fiftyone.core.threed.shape_3d.SphereGeometry.html#theta_length

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.SphereGeometry.__init__

fiftyone.core.threed.shape_3d.SphereGeometry.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.SphereGeometry._to_dict_extra

fiftyone.core.threed.shape_3d.SphereGeometry.html#_to_dict_extra

Function

Method

PRIVATE

Returns the extra data to include in the dict representation.
fiftyone.core.threed.shape_3d.PlaneGeometry

fiftyone.core.threed.shape_3d.PlaneGeometry.html

Class

Class

PUBLIC

Represents a 3D plane.
fiftyone.core.threed.shape_3d.PlaneGeometry.width

fiftyone.core.threed.shape_3d.PlaneGeometry.html#width

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.PlaneGeometry.height

fiftyone.core.threed.shape_3d.PlaneGeometry.html#height

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.PlaneGeometry.__init__

fiftyone.core.threed.shape_3d.PlaneGeometry.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.shape_3d.PlaneGeometry._to_dict_extra

fiftyone.core.threed.shape_3d.PlaneGeometry.html#_to_dict_extra

Function

Method

PRIVATE

Returns the extra data to include in the dict representation.
fiftyone.core.threed.scene_3d.fo3d_path_attributes

fiftyone.core.threed.scene_3d.html#fo3d_path_attributes

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground

fiftyone.core.threed.scene_3d.SceneBackground.html

Class

Class

PUBLIC

Represents the background of the scene.
fiftyone.core.threed.scene_3d.SceneBackground.__init__

fiftyone.core.threed.scene_3d.SceneBackground.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground.color 0

fiftyone.core.threed.scene_3d.SceneBackground.html#color%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground.color

fiftyone.core.threed.scene_3d.SceneBackground.html#color

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground.color.setter

fiftyone.core.threed.scene_3d.SceneBackground.html#color.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground._color

fiftyone.core.threed.scene_3d.SceneBackground.html#_color

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground.image 0

fiftyone.core.threed.scene_3d.SceneBackground.html#image%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground.image

fiftyone.core.threed.scene_3d.SceneBackground.html#image

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground.image.setter

fiftyone.core.threed.scene_3d.SceneBackground.html#image.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground._image

fiftyone.core.threed.scene_3d.SceneBackground.html#_image

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground.cube 0

fiftyone.core.threed.scene_3d.SceneBackground.html#cube%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground.cube

fiftyone.core.threed.scene_3d.SceneBackground.html#cube

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground.cube.setter

fiftyone.core.threed.scene_3d.SceneBackground.html#cube.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground._cube

fiftyone.core.threed.scene_3d.SceneBackground.html#_cube

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground.intensity 0

fiftyone.core.threed.scene_3d.SceneBackground.html#intensity%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground.intensity

fiftyone.core.threed.scene_3d.SceneBackground.html#intensity

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground.intensity.setter

fiftyone.core.threed.scene_3d.SceneBackground.html#intensity.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground._intensity

fiftyone.core.threed.scene_3d.SceneBackground.html#_intensity

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground.as_dict

fiftyone.core.threed.scene_3d.SceneBackground.html#as_dict

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.SceneBackground._from_dict

fiftyone.core.threed.scene_3d.SceneBackground.html#_from_dict

Function

Static Method

PRIVATE

Undocumented
fiftyone.core.threed.scene_3d.Scene

fiftyone.core.threed.scene_3d.Scene.html

Class

Class

PUBLIC

Represents a scene graph which contains a hierarchy of 3D objects.
fiftyone.core.threed.scene_3d.Scene.camera

fiftyone.core.threed.scene_3d.Scene.html#camera

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.Scene.lights

fiftyone.core.threed.scene_3d.Scene.html#lights

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.Scene.background

fiftyone.core.threed.scene_3d.Scene.html#background

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.Scene.__init__

fiftyone.core.threed.scene_3d.Scene.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.Scene.__repr__

fiftyone.core.threed.scene_3d.Scene.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.threed.scene_3d.Scene.copy

fiftyone.core.threed.scene_3d.Scene.html#copy

Function

Method

PUBLIC

Returns a deep copy of the scene.
fiftyone.core.threed.scene_3d.Scene._resolve_node_asset_paths

fiftyone.core.threed.scene_3d.Scene.html#_resolve_node_asset_paths

Function

Method

PRIVATE

Undocumented
fiftyone.core.threed.scene_3d.Scene.write

fiftyone.core.threed.scene_3d.Scene.html#write

Function

Method

PUBLIC

Export the scene to a .fo3d file.
fiftyone.core.threed.scene_3d.Scene.traverse

fiftyone.core.threed.scene_3d.Scene.html#traverse

Function

Method

PUBLIC

Traverse the scene graph.
fiftyone.core.threed.scene_3d.Scene.update_asset_paths

fiftyone.core.threed.scene_3d.Scene.html#update_asset_paths

Function

Method

PUBLIC

Update asset paths in this scene according to an input dict mapping.
fiftyone.core.threed.scene_3d.Scene.get_scene_summary

fiftyone.core.threed.scene_3d.Scene.html#get_scene_summary

Function

Method

PUBLIC

Returns a summary of the scene.
fiftyone.core.threed.scene_3d.Scene.get_asset_paths

fiftyone.core.threed.scene_3d.Scene.html#get_asset_paths

Function

Method

PUBLIC

Returns a list of all asset paths in the scene.
fiftyone.core.threed.scene_3d.Scene._resolve_asset_path

fiftyone.core.threed.scene_3d.Scene.html#_resolve_asset_path

Function

Method

PRIVATE

Undocumented
fiftyone.core.threed.scene_3d.Scene._to_dict_extra

fiftyone.core.threed.scene_3d.Scene.html#_to_dict_extra

Function

Method

PRIVATE

Returns the extra data to include in the dict representation.
fiftyone.core.threed.scene_3d.Scene._from_fo3d_dict

fiftyone.core.threed.scene_3d.Scene.html#_from_fo3d_dict

Function

Static Method

PRIVATE

Undocumented
fiftyone.core.threed.scene_3d.Scene.from_fo3d

fiftyone.core.threed.scene_3d.Scene.html#from_fo3d

Function

Static Method

PUBLIC

Loads a scene from an FO3D file.
fiftyone.core.stages.fob

fiftyone.core.stages.html#fob

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.stages.focl

fiftyone.core.stages.html#focl

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.stages.foc

fiftyone.core.stages.html#foc

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.stages.fod

fiftyone.core.stages.html#fod

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.stages.fop

fiftyone.core.stages.html#fop

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.stages.fov

fiftyone.core.stages.html#fov

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.stages.fovi

fiftyone.core.stages.html#fovi

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.stages.foug

fiftyone.core.stages.html#foug

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.stages.ViewStage

fiftyone.core.stages.ViewStage.html

Class

Class

PUBLIC

Abstract base class for all view stages.
fiftyone.core.stages.ViewStage._uuid

fiftyone.core.stages.ViewStage.html#_uuid

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ViewStage.__str__

fiftyone.core.stages.ViewStage.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.ViewStage.__repr__

fiftyone.core.stages.ViewStage.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.ViewStage.__eq__

fiftyone.core.stages.ViewStage.html#__eq__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.ViewStage.has_view

fiftyone.core.stages.ViewStage.html#has_view

Attribute

Property

PUBLIC

Whether this stage's output view should be loaded via load_view rather than appending stages to an aggregation pipeline via to_mongo.
fiftyone.core.stages.ViewStage.outputs_dynamic_groups

fiftyone.core.stages.ViewStage.html#outputs_dynamic_groups

Attribute

Property

PUBLIC

Whether this stage outputs or flattens dynamic groups.
fiftyone.core.stages.ViewStage.get_edited_fields

fiftyone.core.stages.ViewStage.html#get_edited_fields

Function

Method

PUBLIC

Returns a list of names of fields or embedded fields that may have been edited by the stage, if any.
fiftyone.core.stages.ViewStage.get_filtered_fields

fiftyone.core.stages.ViewStage.html#get_filtered_fields

Function

Method

PUBLIC

Returns a list of names of fields or embedded fields that contain arrays have been filtered by the stage, if any.
fiftyone.core.stages.ViewStage.get_selected_fields

fiftyone.core.stages.ViewStage.html#get_selected_fields

Function

Method

PUBLIC

Returns a list of fields that have been selected by the stage, if any.
fiftyone.core.stages.ViewStage.get_excluded_fields

fiftyone.core.stages.ViewStage.html#get_excluded_fields

Function

Method

PUBLIC

Returns a list of fields that have been excluded by the stage, if any.
fiftyone.core.stages.ViewStage.get_media_type

fiftyone.core.stages.ViewStage.html#get_media_type

Function

Method

PUBLIC

Returns the media type outputted by this stage when applied to the given collection, if and only if it is different from the input type.
fiftyone.core.stages.ViewStage.get_group_expr

fiftyone.core.stages.ViewStage.html#get_group_expr

Function

Method

PUBLIC

Returns the dynamic group expression for the given stage, if any.
fiftyone.core.stages.ViewStage.load_view

fiftyone.core.stages.ViewStage.html#load_view

Function

Method

PUBLIC

Loads the fiftyone.core.view.DatasetView containing the output of the stage.
fiftyone.core.stages.ViewStage.to_mongo

fiftyone.core.stages.ViewStage.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.ViewStage.validate

fiftyone.core.stages.ViewStage.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.ViewStage._needs_frames

fiftyone.core.stages.ViewStage.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.ViewStage._needs_group_slices

fiftyone.core.stages.ViewStage.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.ViewStage._serialize

fiftyone.core.stages.ViewStage.html#_serialize

Function

Method

PRIVATE

Returns a JSON dict representation of the ViewStage.
fiftyone.core.stages.ViewStage._kwargs

fiftyone.core.stages.ViewStage.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.ViewStage._params

fiftyone.core.stages.ViewStage.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.ViewStage._from_dict

fiftyone.core.stages.ViewStage.html#_from_dict

Function

Class Method

PRIVATE

Creates a ViewStage instance from a serialized JSON dict representation of it.
fiftyone.core.stages.ViewStageError

fiftyone.core.stages.ViewStageError.html

Class

Exception

PUBLIC

An error raised when a problem with a ViewStage is encountered.
fiftyone.core.stages.Concat

fiftyone.core.stages.Concat.html

Class

Class

PUBLIC

Concatenates the contents of the given fiftyone.core.collections.SampleCollection to this collection.
fiftyone.core.stages.Concat.__init__

fiftyone.core.stages.Concat.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.Concat._samples

fiftyone.core.stages.Concat.html#_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Concat._view

fiftyone.core.stages.Concat.html#_view

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Concat.samples

fiftyone.core.stages.Concat.html#samples

Attribute

Property

PUBLIC

The fiftyone.core.collections.SampleCollection whose contents to append to this collection.
fiftyone.core.stages.Concat.to_mongo

fiftyone.core.stages.Concat.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.Concat.validate

fiftyone.core.stages.Concat.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.Concat._kwargs

fiftyone.core.stages.Concat.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.Concat._params

fiftyone.core.stages.Concat.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.Concat._parse_params

fiftyone.core.stages.Concat.html#_parse_params

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.Concat._serialize_view

fiftyone.core.stages.Concat.html#_serialize_view

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.Concat._load_view

fiftyone.core.stages.Concat.html#_load_view

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.Exclude

fiftyone.core.stages.Exclude.html

Class

Class

PUBLIC

Excludes the samples with the given IDs from a collection.
fiftyone.core.stages.Exclude.__init__

fiftyone.core.stages.Exclude.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.Exclude._sample_ids

fiftyone.core.stages.Exclude.html#_sample_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Exclude.sample_ids

fiftyone.core.stages.Exclude.html#sample_ids

Attribute

Property

PUBLIC

The list of sample IDs to exclude.
fiftyone.core.stages.Exclude.to_mongo

fiftyone.core.stages.Exclude.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.Exclude._kwargs

fiftyone.core.stages.Exclude.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.Exclude._params

fiftyone.core.stages.Exclude.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.ExcludeBy

fiftyone.core.stages.ExcludeBy.html

Class

Class

PUBLIC

Excludes the samples with the given field values from a collection.
fiftyone.core.stages.ExcludeBy.__init__

fiftyone.core.stages.ExcludeBy.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.ExcludeBy._field

fiftyone.core.stages.ExcludeBy.html#_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeBy._values

fiftyone.core.stages.ExcludeBy.html#_values

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeBy.field

fiftyone.core.stages.ExcludeBy.html#field

Attribute

Property

PUBLIC

The field whose values to exclude by.
fiftyone.core.stages.ExcludeBy.values

fiftyone.core.stages.ExcludeBy.html#values

Attribute

Property

PUBLIC

The list of values to exclude by.
fiftyone.core.stages.ExcludeBy.to_mongo

fiftyone.core.stages.ExcludeBy.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.ExcludeBy._kwargs

fiftyone.core.stages.ExcludeBy.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.ExcludeBy._params

fiftyone.core.stages.ExcludeBy.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.ExcludeFields

fiftyone.core.stages.ExcludeFields.html

Class

Class

PUBLIC

Excludes the fields with the given names from the samples in a collection.
fiftyone.core.stages.ExcludeFields.__init__

fiftyone.core.stages.ExcludeFields.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.ExcludeFields._field_names

fiftyone.core.stages.ExcludeFields.html#_field_names

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeFields._meta_filter

fiftyone.core.stages.ExcludeFields.html#_meta_filter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeFields._allow_missing

fiftyone.core.stages.ExcludeFields.html#_allow_missing

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeFields.field_names

fiftyone.core.stages.ExcludeFields.html#field_names

Attribute

Property

PUBLIC

A list of field names to exclude.
fiftyone.core.stages.ExcludeFields.meta_filter

fiftyone.core.stages.ExcludeFields.html#meta_filter

Attribute

Property

PUBLIC

A filter that dynamically excludes fields.
fiftyone.core.stages.ExcludeFields.get_excluded_fields

fiftyone.core.stages.ExcludeFields.html#get_excluded_fields

Function

Method

PUBLIC

Returns a list of fields that have been excluded by the stage, if any.
fiftyone.core.stages.ExcludeFields._get_excluded_fields

fiftyone.core.stages.ExcludeFields.html#_get_excluded_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeFields._get_excluded_frame_fields

fiftyone.core.stages.ExcludeFields.html#_get_excluded_frame_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeFields.to_mongo

fiftyone.core.stages.ExcludeFields.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.ExcludeFields._needs_frames

fiftyone.core.stages.ExcludeFields.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.ExcludeFields._needs_group_slices

fiftyone.core.stages.ExcludeFields.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.ExcludeFields._kwargs

fiftyone.core.stages.ExcludeFields.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.ExcludeFields._params

fiftyone.core.stages.ExcludeFields.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.ExcludeFields.validate

fiftyone.core.stages.ExcludeFields.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages._get_meta_filtered_fields

fiftyone.core.stages.html#_get_meta_filtered_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._matches_field_meta

fiftyone.core.stages.html#_matches_field_meta

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._recursive_match

fiftyone.core.stages.html#_recursive_match

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._parse_paths

fiftyone.core.stages.html#_parse_paths

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeFrames

fiftyone.core.stages.ExcludeFrames.html

Class

Class

PUBLIC

Excludes the frames with the given IDs from a video collection.
fiftyone.core.stages.ExcludeFrames.__init__

fiftyone.core.stages.ExcludeFrames.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.ExcludeFrames._frame_ids

fiftyone.core.stages.ExcludeFrames.html#_frame_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeFrames._omit_empty

fiftyone.core.stages.ExcludeFrames.html#_omit_empty

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeFrames.frame_ids

fiftyone.core.stages.ExcludeFrames.html#frame_ids

Attribute

Property

PUBLIC

The list of frame IDs to exclude.
fiftyone.core.stages.ExcludeFrames.omit_empty

fiftyone.core.stages.ExcludeFrames.html#omit_empty

Attribute

Property

PUBLIC

Whether to omit samples that have no frames after filtering.
fiftyone.core.stages.ExcludeFrames.to_mongo

fiftyone.core.stages.ExcludeFrames.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.ExcludeFrames._kwargs

fiftyone.core.stages.ExcludeFrames.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.ExcludeFrames._params

fiftyone.core.stages.ExcludeFrames.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.ExcludeFrames._needs_frames

fiftyone.core.stages.ExcludeFrames.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.ExcludeFrames.validate

fiftyone.core.stages.ExcludeFrames.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.ExcludeGroups

fiftyone.core.stages.ExcludeGroups.html

Class

Class

PUBLIC

Excludes the groups with the given IDs from a grouped collection.
fiftyone.core.stages.ExcludeGroups.__init__

fiftyone.core.stages.ExcludeGroups.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.ExcludeGroups._group_ids

fiftyone.core.stages.ExcludeGroups.html#_group_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeGroups.group_ids

fiftyone.core.stages.ExcludeGroups.html#group_ids

Attribute

Property

PUBLIC

The list of group IDs to exclude.
fiftyone.core.stages.ExcludeGroups.to_mongo

fiftyone.core.stages.ExcludeGroups.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.ExcludeGroups._kwargs

fiftyone.core.stages.ExcludeGroups.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.ExcludeGroups._params

fiftyone.core.stages.ExcludeGroups.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.ExcludeGroups.validate

fiftyone.core.stages.ExcludeGroups.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.ExcludeLabels

fiftyone.core.stages.ExcludeLabels.html

Class

Class

PUBLIC

Excludes the specified labels from a collection.
fiftyone.core.stages.ExcludeLabels.__init__

fiftyone.core.stages.ExcludeLabels.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.ExcludeLabels._labels

fiftyone.core.stages.ExcludeLabels.html#_labels

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeLabels._ids

fiftyone.core.stages.ExcludeLabels.html#_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeLabels._tags

fiftyone.core.stages.ExcludeLabels.html#_tags

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeLabels._fields

fiftyone.core.stages.ExcludeLabels.html#_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeLabels._omit_empty

fiftyone.core.stages.ExcludeLabels.html#_omit_empty

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeLabels._sample_ids

fiftyone.core.stages.ExcludeLabels.html#_sample_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeLabels._labels_map

fiftyone.core.stages.ExcludeLabels.html#_labels_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeLabels._pipeline

fiftyone.core.stages.ExcludeLabels.html#_pipeline

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeLabels.labels

fiftyone.core.stages.ExcludeLabels.html#labels

Attribute

Property

PUBLIC

A list of dicts specifying the labels to exclude.
fiftyone.core.stages.ExcludeLabels.ids

fiftyone.core.stages.ExcludeLabels.html#ids

Attribute

Property

PUBLIC

A list of IDs of labels to exclude.
fiftyone.core.stages.ExcludeLabels.tags

fiftyone.core.stages.ExcludeLabels.html#tags

Attribute

Property

PUBLIC

A list of tags of labels to exclude.
fiftyone.core.stages.ExcludeLabels.fields

fiftyone.core.stages.ExcludeLabels.html#fields

Attribute

Property

PUBLIC

A list of fields from which labels are being excluded.
fiftyone.core.stages.ExcludeLabels.omit_empty

fiftyone.core.stages.ExcludeLabels.html#omit_empty

Attribute

Property

PUBLIC

Whether to omit samples that have no labels after filtering.
fiftyone.core.stages.ExcludeLabels.get_edited_fields

fiftyone.core.stages.ExcludeLabels.html#get_edited_fields

Function

Method

PUBLIC

Returns a list of names of fields or embedded fields that may have been edited by the stage, if any.
fiftyone.core.stages.ExcludeLabels.get_filtered_fields

fiftyone.core.stages.ExcludeLabels.html#get_filtered_fields

Function

Method

PUBLIC

Returns a list of names of fields or embedded fields that contain arrays have been filtered by the stage, if any.
fiftyone.core.stages.ExcludeLabels.to_mongo

fiftyone.core.stages.ExcludeLabels.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.ExcludeLabels._kwargs

fiftyone.core.stages.ExcludeLabels.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.ExcludeLabels._params

fiftyone.core.stages.ExcludeLabels.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.ExcludeLabels._needs_frames

fiftyone.core.stages.ExcludeLabels.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.ExcludeLabels._needs_group_slices

fiftyone.core.stages.ExcludeLabels.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.ExcludeLabels._make_labels_pipeline

fiftyone.core.stages.ExcludeLabels.html#_make_labels_pipeline

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeLabels._make_pipeline

fiftyone.core.stages.ExcludeLabels.html#_make_pipeline

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.ExcludeLabels.validate

fiftyone.core.stages.ExcludeLabels.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.Exists

fiftyone.core.stages.Exists.html

Class

Class

PUBLIC

Returns a view containing the samples in a collection that have (or do not have) a non-None value for the given field or embedded field.
fiftyone.core.stages.Exists.__init__

fiftyone.core.stages.Exists.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.Exists._field

fiftyone.core.stages.Exists.html#_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Exists._bool

fiftyone.core.stages.Exists.html#_bool

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Exists.field

fiftyone.core.stages.Exists.html#field

Attribute

Property

PUBLIC

The field to check for existence.
fiftyone.core.stages.Exists.bool

fiftyone.core.stages.Exists.html#bool

Attribute

Property

PUBLIC

Whether to check if the field exists (True) or does not exist (False).
fiftyone.core.stages.Exists.to_mongo

fiftyone.core.stages.Exists.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.Exists._needs_frames

fiftyone.core.stages.Exists.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.Exists._needs_group_slices

fiftyone.core.stages.Exists.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.Exists._kwargs

fiftyone.core.stages.Exists.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.Exists._params

fiftyone.core.stages.Exists.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.FilterField

fiftyone.core.stages.FilterField.html

Class

Class

PUBLIC

Filters the values of a given field or embedded field of each sample in a collection.
fiftyone.core.stages.FilterField.__init__

fiftyone.core.stages.FilterField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.FilterField._field

fiftyone.core.stages.FilterField.html#_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterField._filter

fiftyone.core.stages.FilterField.html#_filter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterField._only_matches

fiftyone.core.stages.FilterField.html#_only_matches

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterField._new_field

fiftyone.core.stages.FilterField.html#_new_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterField._is_frame_field

fiftyone.core.stages.FilterField.html#_is_frame_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterField.field

fiftyone.core.stages.FilterField.html#field

Attribute

Property

PUBLIC

The field to filter.
fiftyone.core.stages.FilterField.filter

fiftyone.core.stages.FilterField.html#filter

Attribute

Property

PUBLIC

The filter expression.
fiftyone.core.stages.FilterField.only_matches

fiftyone.core.stages.FilterField.html#only_matches

Attribute

Property

PUBLIC

Whether to only include samples that match the filter.
fiftyone.core.stages.FilterField.get_edited_fields

fiftyone.core.stages.FilterField.html#get_edited_fields

Function

Method

PUBLIC

Returns a list of names of fields or embedded fields that may have been edited by the stage, if any.
fiftyone.core.stages.FilterField.to_mongo

fiftyone.core.stages.FilterField.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.FilterField._get_mongo_filter

fiftyone.core.stages.FilterField.html#_get_mongo_filter

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.FilterField._get_new_field

fiftyone.core.stages.FilterField.html#_get_new_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.FilterField._needs_frames

fiftyone.core.stages.FilterField.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.FilterField._needs_group_slices

fiftyone.core.stages.FilterField.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.FilterField._kwargs

fiftyone.core.stages.FilterField.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.FilterField._params

fiftyone.core.stages.FilterField.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.FilterField._validate_params

fiftyone.core.stages.FilterField.html#_validate_params

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.FilterField.validate

fiftyone.core.stages.FilterField.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages._get_filter_field_pipeline

fiftyone.core.stages.html#_get_filter_field_pipeline

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._get_field_only_matches_expr

fiftyone.core.stages.html#_get_field_only_matches_expr

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._get_filter_frames_field_pipeline

fiftyone.core.stages.html#_get_filter_frames_field_pipeline

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._get_frames_field_only_matches_expr

fiftyone.core.stages.html#_get_frames_field_only_matches_expr

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._get_field_mongo_filter

fiftyone.core.stages.html#_get_field_mongo_filter

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages.FilterLabels

fiftyone.core.stages.FilterLabels.html

Class

Class

PUBLIC

Filters the fiftyone.core.labels.Label field of each sample in a collection.
fiftyone.core.stages.FilterLabels.__init__

fiftyone.core.stages.FilterLabels.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.FilterLabels._field

fiftyone.core.stages.FilterLabels.html#_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterLabels._filter

fiftyone.core.stages.FilterLabels.html#_filter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterLabels._only_matches

fiftyone.core.stages.FilterLabels.html#_only_matches

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterLabels._trajectories

fiftyone.core.stages.FilterLabels.html#_trajectories

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterLabels._new_field

fiftyone.core.stages.FilterLabels.html#_new_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterLabels._labels_field

fiftyone.core.stages.FilterLabels.html#_labels_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterLabels._is_frame_field

fiftyone.core.stages.FilterLabels.html#_is_frame_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterLabels._is_labels_list_field

fiftyone.core.stages.FilterLabels.html#_is_labels_list_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterLabels.field

fiftyone.core.stages.FilterLabels.html#field

Attribute

Property

PUBLIC

The label field to filter.
fiftyone.core.stages.FilterLabels.filter

fiftyone.core.stages.FilterLabels.html#filter

Attribute

Property

PUBLIC

The filter expression.
fiftyone.core.stages.FilterLabels.only_matches

fiftyone.core.stages.FilterLabels.html#only_matches

Attribute

Property

PUBLIC

Whether to only include samples that match the filter.
fiftyone.core.stages.FilterLabels.trajectories

fiftyone.core.stages.FilterLabels.html#trajectories

Attribute

Property

PUBLIC

Whether to match entire object trajectories for which the object matches the given filter on at least one frame.
fiftyone.core.stages.FilterLabels.get_edited_fields

fiftyone.core.stages.FilterLabels.html#get_edited_fields

Function

Method

PUBLIC

Returns a list of names of fields or embedded fields that may have been edited by the stage, if any.
fiftyone.core.stages.FilterLabels.get_filtered_fields

fiftyone.core.stages.FilterLabels.html#get_filtered_fields

Function

Method

PUBLIC

Returns a list of names of fields or embedded fields that contain arrays have been filtered by the stage, if any.
fiftyone.core.stages.FilterLabels.to_mongo

fiftyone.core.stages.FilterLabels.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.FilterLabels._parse_labels_field

fiftyone.core.stages.FilterLabels.html#_parse_labels_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.FilterLabels._get_mongo_filter

fiftyone.core.stages.FilterLabels.html#_get_mongo_filter

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.FilterLabels._get_new_field

fiftyone.core.stages.FilterLabels.html#_get_new_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.FilterLabels._needs_frames

fiftyone.core.stages.FilterLabels.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.FilterLabels._needs_group_slices

fiftyone.core.stages.FilterLabels.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.FilterLabels._kwargs

fiftyone.core.stages.FilterLabels.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.FilterLabels._params

fiftyone.core.stages.FilterLabels.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.FilterLabels._validate_params

fiftyone.core.stages.FilterLabels.html#_validate_params

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.FilterLabels.validate

fiftyone.core.stages.FilterLabels.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages._get_filter_list_field_pipeline

fiftyone.core.stages.html#_get_filter_list_field_pipeline

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._get_list_field_only_matches_expr

fiftyone.core.stages.html#_get_list_field_only_matches_expr

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._get_filter_frames_list_field_pipeline

fiftyone.core.stages.html#_get_filter_frames_list_field_pipeline

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._get_frames_list_field_only_matches_expr

fiftyone.core.stages.html#_get_frames_list_field_only_matches_expr

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._get_trajectories_filter

fiftyone.core.stages.html#_get_trajectories_filter

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._get_trajectory_mongo_filter

fiftyone.core.stages.html#_get_trajectory_mongo_filter

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._get_list_trajectory_mongo_filter

fiftyone.core.stages.html#_get_list_trajectory_mongo_filter

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._get_list_field_mongo_filter

fiftyone.core.stages.html#_get_list_field_mongo_filter

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages.FilterKeypoints

fiftyone.core.stages.FilterKeypoints.html

Class

Class

PUBLIC

Filters the individual fiftyone.core.labels.Keypoint.points elements in the specified keypoints field of each sample in the collection.
fiftyone.core.stages.FilterKeypoints.__init__

fiftyone.core.stages.FilterKeypoints.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.FilterKeypoints._field

fiftyone.core.stages.FilterKeypoints.html#_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterKeypoints._filter

fiftyone.core.stages.FilterKeypoints.html#_filter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterKeypoints._labels

fiftyone.core.stages.FilterKeypoints.html#_labels

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterKeypoints._only_matches

fiftyone.core.stages.FilterKeypoints.html#_only_matches

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterKeypoints._new_field

fiftyone.core.stages.FilterKeypoints.html#_new_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterKeypoints._filter_dict

fiftyone.core.stages.FilterKeypoints.html#_filter_dict

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterKeypoints._filter_field

fiftyone.core.stages.FilterKeypoints.html#_filter_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterKeypoints._filter_expr

fiftyone.core.stages.FilterKeypoints.html#_filter_expr

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.FilterKeypoints.filter

fiftyone.core.stages.FilterKeypoints.html#filter

Attribute

Property

PUBLIC

The filter expression.
fiftyone.core.stages.FilterKeypoints.labels

fiftyone.core.stages.FilterKeypoints.html#labels

Attribute

Property

PUBLIC

An iterable of keypoint skeleton labels to keep.
fiftyone.core.stages.FilterKeypoints.only_matches

fiftyone.core.stages.FilterKeypoints.html#only_matches

Attribute

Property

PUBLIC

Whether to only include samples that match the filter.
fiftyone.core.stages.FilterKeypoints.get_edited_fields

fiftyone.core.stages.FilterKeypoints.html#get_edited_fields

Function

Method

PUBLIC

Returns a list of names of fields or embedded fields that may have been edited by the stage, if any.
fiftyone.core.stages.FilterKeypoints.to_mongo

fiftyone.core.stages.FilterKeypoints.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.FilterKeypoints._get_new_field

fiftyone.core.stages.FilterKeypoints.html#_get_new_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.FilterKeypoints._needs_frames

fiftyone.core.stages.FilterKeypoints.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.FilterKeypoints._needs_group_slices

fiftyone.core.stages.FilterKeypoints.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.FilterKeypoints._kwargs

fiftyone.core.stages.FilterKeypoints.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.FilterKeypoints._validate_params

fiftyone.core.stages.FilterKeypoints.html#_validate_params

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.FilterKeypoints._params

fiftyone.core.stages.FilterKeypoints.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages._extract_filter_field

fiftyone.core.stages.html#_extract_filter_field

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._GeoStage

fiftyone.core.stages._GeoStage.html

Class

Class

PRIVATE

No class docstring; 2/2 properties, 0/3 instance variable, 0/2 method documented
fiftyone.core.stages._GeoStage.__init__

fiftyone.core.stages._GeoStage.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages._GeoStage._location_field

fiftyone.core.stages._GeoStage.html#_location_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages._GeoStage._location_key

fiftyone.core.stages._GeoStage.html#_location_key

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages._GeoStage._create_index

fiftyone.core.stages._GeoStage.html#_create_index

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages._GeoStage.location_field

fiftyone.core.stages._GeoStage.html#location_field

Attribute

Property

PUBLIC

The location field.
fiftyone.core.stages._GeoStage.create_index

fiftyone.core.stages._GeoStage.html#create_index

Attribute

Property

PUBLIC

Whether to create the required spherical index, if necessary.
fiftyone.core.stages._GeoStage.validate

fiftyone.core.stages._GeoStage.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.GeoNear

fiftyone.core.stages.GeoNear.html

Class

Class

PUBLIC

Sorts the samples in a collection by their proximity to a specified geolocation.
fiftyone.core.stages.GeoNear.__init__

fiftyone.core.stages.GeoNear.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.GeoNear._point

fiftyone.core.stages.GeoNear.html#_point

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.GeoNear._min_distance

fiftyone.core.stages.GeoNear.html#_min_distance

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.GeoNear._max_distance

fiftyone.core.stages.GeoNear.html#_max_distance

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.GeoNear._query

fiftyone.core.stages.GeoNear.html#_query

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.GeoNear.point

fiftyone.core.stages.GeoNear.html#point

Attribute

Property

PUBLIC

The point to search proximity to.
fiftyone.core.stages.GeoNear.min_distance

fiftyone.core.stages.GeoNear.html#min_distance

Attribute

Property

PUBLIC

The minimum distance for matches, in meters.
fiftyone.core.stages.GeoNear.max_distance

fiftyone.core.stages.GeoNear.html#max_distance

Attribute

Property

PUBLIC

The maximum distance for matches, in meters.
fiftyone.core.stages.GeoNear.query

fiftyone.core.stages.GeoNear.html#query

Attribute

Property

PUBLIC

A query dict specifying a match condition.
fiftyone.core.stages.GeoNear.to_mongo

fiftyone.core.stages.GeoNear.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.GeoNear._kwargs

fiftyone.core.stages.GeoNear.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.GeoNear._params

fiftyone.core.stages.GeoNear.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.GeoWithin

fiftyone.core.stages.GeoWithin.html

Class

Class

PUBLIC

Filters the samples in a collection to only match samples whose geolocation is within a specified boundary.
fiftyone.core.stages.GeoWithin.__init__

fiftyone.core.stages.GeoWithin.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.GeoWithin._boundary

fiftyone.core.stages.GeoWithin.html#_boundary

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.GeoWithin._strict

fiftyone.core.stages.GeoWithin.html#_strict

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.GeoWithin.boundary

fiftyone.core.stages.GeoWithin.html#boundary

Attribute

Property

PUBLIC

A GeoJSON dict describing the boundary to match within.
fiftyone.core.stages.GeoWithin.strict

fiftyone.core.stages.GeoWithin.html#strict

Attribute

Property

PUBLIC

Whether matches must be strictly contained in the boundary.
fiftyone.core.stages.GeoWithin.to_mongo

fiftyone.core.stages.GeoWithin.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.GeoWithin._kwargs

fiftyone.core.stages.GeoWithin.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.GeoWithin._params

fiftyone.core.stages.GeoWithin.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.GroupBy

fiftyone.core.stages.GroupBy.html

Class

Class

PUBLIC

Creates a view that groups the samples in a collection by a specified field or expression.
fiftyone.core.stages.GroupBy.__init__

fiftyone.core.stages.GroupBy.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.GroupBy._field_or_expr

fiftyone.core.stages.GroupBy.html#_field_or_expr

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.GroupBy._order_by

fiftyone.core.stages.GroupBy.html#_order_by

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.GroupBy._reverse

fiftyone.core.stages.GroupBy.html#_reverse

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.GroupBy._flat

fiftyone.core.stages.GroupBy.html#_flat

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.GroupBy._match_expr

fiftyone.core.stages.GroupBy.html#_match_expr

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.GroupBy._sort_expr

fiftyone.core.stages.GroupBy.html#_sort_expr

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.GroupBy._create_index

fiftyone.core.stages.GroupBy.html#_create_index

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.GroupBy._sort_stage

fiftyone.core.stages.GroupBy.html#_sort_stage

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.GroupBy.outputs_dynamic_groups

fiftyone.core.stages.GroupBy.html#outputs_dynamic_groups

Attribute

Property

PUBLIC

Whether this stage outputs or flattens dynamic groups.
fiftyone.core.stages.GroupBy.field_or_expr

fiftyone.core.stages.GroupBy.html#field_or_expr

Attribute

Property

PUBLIC

The field or expression to group by.
fiftyone.core.stages.GroupBy.order_by

fiftyone.core.stages.GroupBy.html#order_by

Attribute

Property

PUBLIC

The field by which to order the samples in each group.
fiftyone.core.stages.GroupBy.reverse

fiftyone.core.stages.GroupBy.html#reverse

Attribute

Property

PUBLIC

Whether to sort the groups in descending order.
fiftyone.core.stages.GroupBy.flat

fiftyone.core.stages.GroupBy.html#flat

Attribute

Property

PUBLIC

Whether to generate a flattened collection.
fiftyone.core.stages.GroupBy.match_expr

fiftyone.core.stages.GroupBy.html#match_expr

Attribute

Property

PUBLIC

An expression to apply to select groups in the output view.
fiftyone.core.stages.GroupBy.sort_expr

fiftyone.core.stages.GroupBy.html#sort_expr

Attribute

Property

PUBLIC

An expression defining how the sort the groups in the output view.
fiftyone.core.stages.GroupBy.create_index

fiftyone.core.stages.GroupBy.html#create_index

Attribute

Property

PUBLIC

Whether to create an index, if necessary, to optimize the grouping.
fiftyone.core.stages.GroupBy.to_mongo

fiftyone.core.stages.GroupBy.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.GroupBy._make_flat_pipeline

fiftyone.core.stages.GroupBy.html#_make_flat_pipeline

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.GroupBy._make_grouped_pipeline

fiftyone.core.stages.GroupBy.html#_make_grouped_pipeline

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.GroupBy.get_group_expr

fiftyone.core.stages.GroupBy.html#get_group_expr

Function

Method

PUBLIC

Returns the dynamic group expression for the given stage, if any.
fiftyone.core.stages.GroupBy._get_group_expr

fiftyone.core.stages.GroupBy.html#_get_group_expr

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.GroupBy.get_media_type

fiftyone.core.stages.GroupBy.html#get_media_type

Function

Method

PUBLIC

Returns the media type outputted by this stage when applied to the given collection, if and only if it is different from the input type.
fiftyone.core.stages.GroupBy._needs_frames

fiftyone.core.stages.GroupBy.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.GroupBy._needs_group_slices

fiftyone.core.stages.GroupBy.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.GroupBy._get_mongo_field_or_expr

fiftyone.core.stages.GroupBy.html#_get_mongo_field_or_expr

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.GroupBy._get_mongo_match_expr

fiftyone.core.stages.GroupBy.html#_get_mongo_match_expr

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.GroupBy._get_mongo_sort_expr

fiftyone.core.stages.GroupBy.html#_get_mongo_sort_expr

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.GroupBy._kwargs

fiftyone.core.stages.GroupBy.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.GroupBy._params

fiftyone.core.stages.GroupBy.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.GroupBy.validate

fiftyone.core.stages.GroupBy.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.Flatten

fiftyone.core.stages.Flatten.html

Class

Class

PUBLIC

Returns a flattened view that contains all samples in a dynamic grouped collection.
fiftyone.core.stages.Flatten.__init__

fiftyone.core.stages.Flatten.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.Flatten._stages

fiftyone.core.stages.Flatten.html#_stages

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Flatten._stages_kwargs

fiftyone.core.stages.Flatten.html#_stages_kwargs

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Flatten._pipeline

fiftyone.core.stages.Flatten.html#_pipeline

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Flatten.outputs_dynamic_groups

fiftyone.core.stages.Flatten.html#outputs_dynamic_groups

Attribute

Property

PUBLIC

Whether this stage outputs or flattens dynamic groups.
fiftyone.core.stages.Flatten.stages

fiftyone.core.stages.Flatten.html#stages

Attribute

Property

PUBLIC

Stage(s) to apply to each group's samples while flattening.
fiftyone.core.stages.Flatten.to_mongo

fiftyone.core.stages.Flatten.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.Flatten.get_media_type

fiftyone.core.stages.Flatten.html#get_media_type

Function

Method

PUBLIC

Returns the media type outputted by this stage when applied to the given collection, if and only if it is different from the input type.
fiftyone.core.stages.Flatten.validate

fiftyone.core.stages.Flatten.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.Flatten._kwargs

fiftyone.core.stages.Flatten.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.Flatten._params

fiftyone.core.stages.Flatten.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages._parse_stages

fiftyone.core.stages.html#_parse_stages

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages.Limit

fiftyone.core.stages.Limit.html

Class

Class

PUBLIC

Creates a view with at most the given number of samples.
fiftyone.core.stages.Limit.__init__

fiftyone.core.stages.Limit.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.Limit._limit

fiftyone.core.stages.Limit.html#_limit

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Limit.limit

fiftyone.core.stages.Limit.html#limit

Attribute

Property

PUBLIC

The maximum number of samples to return.
fiftyone.core.stages.Limit.to_mongo

fiftyone.core.stages.Limit.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.Limit._kwargs

fiftyone.core.stages.Limit.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.Limit._params

fiftyone.core.stages.Limit.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.LimitLabels

fiftyone.core.stages.LimitLabels.html

Class

Class

PUBLIC

Limits the number of fiftyone.core.labels.Label instances in the specified labels list field of each sample in a collection.
fiftyone.core.stages.LimitLabels.__init__

fiftyone.core.stages.LimitLabels.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.LimitLabels._field

fiftyone.core.stages.LimitLabels.html#_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.LimitLabels._limit

fiftyone.core.stages.LimitLabels.html#_limit

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.LimitLabels._labels_list_field

fiftyone.core.stages.LimitLabels.html#_labels_list_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.LimitLabels._is_frame_field

fiftyone.core.stages.LimitLabels.html#_is_frame_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.LimitLabels.field

fiftyone.core.stages.LimitLabels.html#field

Attribute

Property

PUBLIC

The labels field to limit.
fiftyone.core.stages.LimitLabels.limit

fiftyone.core.stages.LimitLabels.html#limit

Attribute

Property

PUBLIC

The maximum number of labels to allow in each labels list.
fiftyone.core.stages.LimitLabels.get_edited_fields

fiftyone.core.stages.LimitLabels.html#get_edited_fields

Function

Method

PUBLIC

Returns a list of names of fields or embedded fields that may have been edited by the stage, if any.
fiftyone.core.stages.LimitLabels.get_filtered_fields

fiftyone.core.stages.LimitLabels.html#get_filtered_fields

Function

Method

PUBLIC

Returns a list of names of fields or embedded fields that contain arrays have been filtered by the stage, if any.
fiftyone.core.stages.LimitLabels.to_mongo

fiftyone.core.stages.LimitLabels.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.LimitLabels._needs_frames

fiftyone.core.stages.LimitLabels.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.LimitLabels._needs_group_slices

fiftyone.core.stages.LimitLabels.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.LimitLabels._kwargs

fiftyone.core.stages.LimitLabels.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.LimitLabels._params

fiftyone.core.stages.LimitLabels.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.LimitLabels.validate

fiftyone.core.stages.LimitLabels.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.MapLabels

fiftyone.core.stages.MapLabels.html

Class

Class

PUBLIC

Maps the label values of a fiftyone.core.labels.Label field to new values for each sample in a collection.
fiftyone.core.stages.MapLabels.__init__

fiftyone.core.stages.MapLabels.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.MapLabels._field

fiftyone.core.stages.MapLabels.html#_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MapLabels._map

fiftyone.core.stages.MapLabels.html#_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MapLabels._labels_field

fiftyone.core.stages.MapLabels.html#_labels_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MapLabels.field

fiftyone.core.stages.MapLabels.html#field

Attribute

Property

PUBLIC

The labels field to map.
fiftyone.core.stages.MapLabels.map

fiftyone.core.stages.MapLabels.html#map

Attribute

Property

PUBLIC

The labels map dict.
fiftyone.core.stages.MapLabels.get_edited_fields

fiftyone.core.stages.MapLabels.html#get_edited_fields

Function

Method

PUBLIC

Returns a list of names of fields or embedded fields that may have been edited by the stage, if any.
fiftyone.core.stages.MapLabels.to_mongo

fiftyone.core.stages.MapLabels.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.MapLabels._needs_frames

fiftyone.core.stages.MapLabels.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.MapLabels._needs_group_slices

fiftyone.core.stages.MapLabels.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.MapLabels._kwargs

fiftyone.core.stages.MapLabels.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.MapLabels._params

fiftyone.core.stages.MapLabels.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.MapLabels.validate

fiftyone.core.stages.MapLabels.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.SetField

fiftyone.core.stages.SetField.html

Class

Class

PUBLIC

Sets a field or embedded field on each sample in a collection by evaluating the given expression.
fiftyone.core.stages.SetField.__init__

fiftyone.core.stages.SetField.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.SetField._field

fiftyone.core.stages.SetField.html#_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SetField._expr

fiftyone.core.stages.SetField.html#_expr

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SetField._allow_missing

fiftyone.core.stages.SetField.html#_allow_missing

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SetField._pipeline

fiftyone.core.stages.SetField.html#_pipeline

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SetField._expr_dict

fiftyone.core.stages.SetField.html#_expr_dict

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SetField.field

fiftyone.core.stages.SetField.html#field

Attribute

Property

PUBLIC

The field to set.
fiftyone.core.stages.SetField.expr

fiftyone.core.stages.SetField.html#expr

Attribute

Property

PUBLIC

The expression to apply.
fiftyone.core.stages.SetField.get_edited_fields

fiftyone.core.stages.SetField.html#get_edited_fields

Function

Method

PUBLIC

Returns a list of names of fields or embedded fields that may have been edited by the stage, if any.
fiftyone.core.stages.SetField.to_mongo

fiftyone.core.stages.SetField.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.SetField._needs_frames

fiftyone.core.stages.SetField.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.SetField._needs_group_slices

fiftyone.core.stages.SetField.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.SetField._kwargs

fiftyone.core.stages.SetField.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.SetField._params

fiftyone.core.stages.SetField.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.SetField._get_mongo_expr

fiftyone.core.stages.SetField.html#_get_mongo_expr

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.SetField.validate

fiftyone.core.stages.SetField.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.Match

fiftyone.core.stages.Match.html

Class

Class

PUBLIC

Filters the samples in the collection by the given filter.
fiftyone.core.stages.Match.__init__

fiftyone.core.stages.Match.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.Match._filter

fiftyone.core.stages.Match.html#_filter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Match.filter

fiftyone.core.stages.Match.html#filter

Attribute

Property

PUBLIC

The filter expression.
fiftyone.core.stages.Match.to_mongo

fiftyone.core.stages.Match.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.Match._needs_frames

fiftyone.core.stages.Match.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.Match._needs_group_slices

fiftyone.core.stages.Match.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.Match._get_mongo_expr

fiftyone.core.stages.Match.html#_get_mongo_expr

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.Match._kwargs

fiftyone.core.stages.Match.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.Match._validate_params

fiftyone.core.stages.Match.html#_validate_params

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.Match._params

fiftyone.core.stages.Match.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.SelectGroupSlices

fiftyone.core.stages.SelectGroupSlices.html

Class

Class

PUBLIC

Selects the samples in a group collection from the given slice(s).
fiftyone.core.stages.SelectGroupSlices.__init__

fiftyone.core.stages.SelectGroupSlices.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.SelectGroupSlices._slices

fiftyone.core.stages.SelectGroupSlices.html#_slices

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectGroupSlices._media_type

fiftyone.core.stages.SelectGroupSlices.html#_media_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectGroupSlices._allow_mixed

fiftyone.core.stages.SelectGroupSlices.html#_allow_mixed

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectGroupSlices._force_mixed

fiftyone.core.stages.SelectGroupSlices.html#_force_mixed

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectGroupSlices.slices

fiftyone.core.stages.SelectGroupSlices.html#slices

Attribute

Property

PUBLIC

The group slice(s) to select.
fiftyone.core.stages.SelectGroupSlices.media_type

fiftyone.core.stages.SelectGroupSlices.html#media_type

Attribute

Property

PUBLIC

The media type whose slices to select.
fiftyone.core.stages.SelectGroupSlices.to_mongo

fiftyone.core.stages.SelectGroupSlices.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.SelectGroupSlices._make_root_pipeline

fiftyone.core.stages.SelectGroupSlices.html#_make_root_pipeline

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.SelectGroupSlices._make_pipeline

fiftyone.core.stages.SelectGroupSlices.html#_make_pipeline

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.SelectGroupSlices.get_media_type

fiftyone.core.stages.SelectGroupSlices.html#get_media_type

Function

Method

PUBLIC

Returns the media type outputted by this stage when applied to the given collection, if and only if it is different from the input type.
fiftyone.core.stages.SelectGroupSlices.validate

fiftyone.core.stages.SelectGroupSlices.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.SelectGroupSlices._get_slices

fiftyone.core.stages.SelectGroupSlices.html#_get_slices

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.SelectGroupSlices._get_group_media_types

fiftyone.core.stages.SelectGroupSlices.html#_get_group_media_types

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.SelectGroupSlices._kwargs

fiftyone.core.stages.SelectGroupSlices.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.SelectGroupSlices._params

fiftyone.core.stages.SelectGroupSlices.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.MatchFrames

fiftyone.core.stages.MatchFrames.html

Class

Class

PUBLIC

Filters the frames in a video collection by the given filter.
fiftyone.core.stages.MatchFrames.__init__

fiftyone.core.stages.MatchFrames.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.MatchFrames._filter

fiftyone.core.stages.MatchFrames.html#_filter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MatchFrames._omit_empty

fiftyone.core.stages.MatchFrames.html#_omit_empty

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MatchFrames.filter

fiftyone.core.stages.MatchFrames.html#filter

Attribute

Property

PUBLIC

The filter expression.
fiftyone.core.stages.MatchFrames.omit_empty

fiftyone.core.stages.MatchFrames.html#omit_empty

Attribute

Property

PUBLIC

Whether to omit samples that have no frames after filtering.
fiftyone.core.stages.MatchFrames._get_mongo_expr

fiftyone.core.stages.MatchFrames.html#_get_mongo_expr

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.MatchFrames.to_mongo

fiftyone.core.stages.MatchFrames.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.MatchFrames._kwargs

fiftyone.core.stages.MatchFrames.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.MatchFrames._params

fiftyone.core.stages.MatchFrames.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.MatchFrames._validate_params

fiftyone.core.stages.MatchFrames.html#_validate_params

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.MatchFrames._needs_frames

fiftyone.core.stages.MatchFrames.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.MatchFrames.validate

fiftyone.core.stages.MatchFrames.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.MatchLabels

fiftyone.core.stages.MatchLabels.html

Class

Class

PUBLIC

Selects the samples from a collection that contain (or do not contain) at least one label that matches the specified criteria.
fiftyone.core.stages.MatchLabels._FILTER_PREFIX

fiftyone.core.stages.MatchLabels.html#_FILTER_PREFIX

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.stages.MatchLabels.__init__

fiftyone.core.stages.MatchLabels.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.MatchLabels._labels

fiftyone.core.stages.MatchLabels.html#_labels

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MatchLabels._ids

fiftyone.core.stages.MatchLabels.html#_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MatchLabels._tags

fiftyone.core.stages.MatchLabels.html#_tags

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MatchLabels._filter

fiftyone.core.stages.MatchLabels.html#_filter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MatchLabels._fields

fiftyone.core.stages.MatchLabels.html#_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MatchLabels._bool

fiftyone.core.stages.MatchLabels.html#_bool

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MatchLabels._sample_ids

fiftyone.core.stages.MatchLabels.html#_sample_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MatchLabels._labels_map

fiftyone.core.stages.MatchLabels.html#_labels_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MatchLabels._pipeline

fiftyone.core.stages.MatchLabels.html#_pipeline

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MatchLabels.labels

fiftyone.core.stages.MatchLabels.html#labels

Attribute

Property

PUBLIC

A list of dicts specifying the labels to match.
fiftyone.core.stages.MatchLabels.ids

fiftyone.core.stages.MatchLabels.html#ids

Attribute

Property

PUBLIC

A list of IDs of labels to match.
fiftyone.core.stages.MatchLabels.tags

fiftyone.core.stages.MatchLabels.html#tags

Attribute

Property

PUBLIC

A list of tags of labels to match.
fiftyone.core.stages.MatchLabels.filter

fiftyone.core.stages.MatchLabels.html#filter

Attribute

Property

PUBLIC

A filter expression that defines the labels to match.
fiftyone.core.stages.MatchLabels.fields

fiftyone.core.stages.MatchLabels.html#fields

Attribute

Property

PUBLIC

A list of fields from which labels are being matched.
fiftyone.core.stages.MatchLabels.bool

fiftyone.core.stages.MatchLabels.html#bool

Attribute

Property

PUBLIC

Whether to match samples that have (None or True) or do not have (False) at least one label that matches the specified criteria.
fiftyone.core.stages.MatchLabels.to_mongo

fiftyone.core.stages.MatchLabels.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.MatchLabels._kwargs

fiftyone.core.stages.MatchLabels.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.MatchLabels._params

fiftyone.core.stages.MatchLabels.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.MatchLabels._get_mongo_filter

fiftyone.core.stages.MatchLabels.html#_get_mongo_filter

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.MatchLabels._needs_frames

fiftyone.core.stages.MatchLabels.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.MatchLabels._needs_group_slices

fiftyone.core.stages.MatchLabels.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.MatchLabels._make_labels_pipeline

fiftyone.core.stages.MatchLabels.html#_make_labels_pipeline

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.MatchLabels._make_pipeline

fiftyone.core.stages.MatchLabels.html#_make_pipeline

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.MatchLabels.validate

fiftyone.core.stages.MatchLabels.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages._render_filter

fiftyone.core.stages.html#_render_filter

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._replace_prefix

fiftyone.core.stages.html#_replace_prefix

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages.MatchTags

fiftyone.core.stages.MatchTags.html

Class

Class

PUBLIC

Returns a view containing the samples in the collection that have or don't have any/all of the given tag(s).
fiftyone.core.stages.MatchTags.__init__

fiftyone.core.stages.MatchTags.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.MatchTags._tags

fiftyone.core.stages.MatchTags.html#_tags

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MatchTags._bool

fiftyone.core.stages.MatchTags.html#_bool

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MatchTags._all

fiftyone.core.stages.MatchTags.html#_all

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.MatchTags.tags

fiftyone.core.stages.MatchTags.html#tags

Attribute

Property

PUBLIC

The list of tags to match.
fiftyone.core.stages.MatchTags.bool

fiftyone.core.stages.MatchTags.html#bool

Attribute

Property

PUBLIC

Whether to match samples that have (True) or do not have (False) any of the given tags.
fiftyone.core.stages.MatchTags.all

fiftyone.core.stages.MatchTags.html#all

Attribute

Property

PUBLIC

Whether to match samples that have (or don't have) all (True) or any (False) of the given tags.
fiftyone.core.stages.MatchTags.to_mongo

fiftyone.core.stages.MatchTags.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.MatchTags._kwargs

fiftyone.core.stages.MatchTags.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.MatchTags._params

fiftyone.core.stages.MatchTags.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.Mongo

fiftyone.core.stages.Mongo.html

Class

Class

PUBLIC

A view stage defined by a raw MongoDB aggregation pipeline.
fiftyone.core.stages.Mongo.__init__

fiftyone.core.stages.Mongo.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.Mongo._pipeline

fiftyone.core.stages.Mongo.html#_pipeline

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Mongo._needs_frames_manual

fiftyone.core.stages.Mongo.html#_needs_frames_manual

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Mongo._group_slices_manual

fiftyone.core.stages.Mongo.html#_group_slices_manual

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Mongo.pipeline

fiftyone.core.stages.Mongo.html#pipeline

Attribute

Property

PUBLIC

The MongoDB aggregation pipeline.
fiftyone.core.stages.Mongo.to_mongo

fiftyone.core.stages.Mongo.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.Mongo._needs_frames

fiftyone.core.stages.Mongo.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.Mongo._needs_group_slices

fiftyone.core.stages.Mongo.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.Mongo._kwargs

fiftyone.core.stages.Mongo.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.Mongo._params

fiftyone.core.stages.Mongo.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.Select

fiftyone.core.stages.Select.html

Class

Class

PUBLIC

Selects the samples with the given IDs from a collection.
fiftyone.core.stages.Select.__init__

fiftyone.core.stages.Select.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.Select._sample_ids

fiftyone.core.stages.Select.html#_sample_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Select._bools

fiftyone.core.stages.Select.html#_bools

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Select._ordered

fiftyone.core.stages.Select.html#_ordered

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Select.sample_ids

fiftyone.core.stages.Select.html#sample_ids

Attribute

Property

PUBLIC

The list of sample IDs to select.
fiftyone.core.stages.Select.ordered

fiftyone.core.stages.Select.html#ordered

Attribute

Property

PUBLIC

Whether to sort the samples in the same order as the IDs.
fiftyone.core.stages.Select.to_mongo

fiftyone.core.stages.Select.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.Select._kwargs

fiftyone.core.stages.Select.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.Select._params

fiftyone.core.stages.Select.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.Select.validate

fiftyone.core.stages.Select.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.SelectBy

fiftyone.core.stages.SelectBy.html

Class

Class

PUBLIC

Selects the samples with the given field values from a collection.
fiftyone.core.stages.SelectBy.__init__

fiftyone.core.stages.SelectBy.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.SelectBy._field

fiftyone.core.stages.SelectBy.html#_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectBy._values

fiftyone.core.stages.SelectBy.html#_values

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectBy._ordered

fiftyone.core.stages.SelectBy.html#_ordered

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectBy.field

fiftyone.core.stages.SelectBy.html#field

Attribute

Property

PUBLIC

The field whose values to select by.
fiftyone.core.stages.SelectBy.values

fiftyone.core.stages.SelectBy.html#values

Attribute

Property

PUBLIC

The list of values to select by.
fiftyone.core.stages.SelectBy.ordered

fiftyone.core.stages.SelectBy.html#ordered

Attribute

Property

PUBLIC

Whether to sort the samples in the same order as the IDs.
fiftyone.core.stages.SelectBy.to_mongo

fiftyone.core.stages.SelectBy.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.SelectBy._kwargs

fiftyone.core.stages.SelectBy.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.SelectBy._params

fiftyone.core.stages.SelectBy.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.SelectFields

fiftyone.core.stages.SelectFields.html

Class

Class

PUBLIC

Selects only the fields with the given names from the samples in the collection. All other fields are excluded.
fiftyone.core.stages.SelectFields.__init__

fiftyone.core.stages.SelectFields.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.SelectFields._field_names

fiftyone.core.stages.SelectFields.html#_field_names

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectFields._meta_filter

fiftyone.core.stages.SelectFields.html#_meta_filter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectFields._allow_missing

fiftyone.core.stages.SelectFields.html#_allow_missing

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectFields._media_types

fiftyone.core.stages.SelectFields.html#_media_types

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectFields.field_names

fiftyone.core.stages.SelectFields.html#field_names

Attribute

Property

PUBLIC

A list of field names to select.
fiftyone.core.stages.SelectFields.meta_filter

fiftyone.core.stages.SelectFields.html#meta_filter

Attribute

Property

PUBLIC

A filter that dynamically selects fields.
fiftyone.core.stages.SelectFields.get_selected_fields

fiftyone.core.stages.SelectFields.html#get_selected_fields

Function

Method

PUBLIC

Returns a list of fields that have been selected by the stage, if any.
fiftyone.core.stages.SelectFields._get_selected_fields

fiftyone.core.stages.SelectFields.html#_get_selected_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.SelectFields._get_selected_frame_fields

fiftyone.core.stages.SelectFields.html#_get_selected_frame_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.SelectFields.to_mongo

fiftyone.core.stages.SelectFields.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.SelectFields._needs_frames

fiftyone.core.stages.SelectFields.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.SelectFields._needs_group_slices

fiftyone.core.stages.SelectFields.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.SelectFields._kwargs

fiftyone.core.stages.SelectFields.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.SelectFields._params

fiftyone.core.stages.SelectFields.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.SelectFields.validate

fiftyone.core.stages.SelectFields.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages._get_roots

fiftyone.core.stages.html#_get_roots

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages.SelectFrames

fiftyone.core.stages.SelectFrames.html

Class

Class

PUBLIC

Selects the frames with the given IDs from a video collection.
fiftyone.core.stages.SelectFrames.__init__

fiftyone.core.stages.SelectFrames.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.SelectFrames._frame_ids

fiftyone.core.stages.SelectFrames.html#_frame_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectFrames._omit_empty

fiftyone.core.stages.SelectFrames.html#_omit_empty

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectFrames.frame_ids

fiftyone.core.stages.SelectFrames.html#frame_ids

Attribute

Property

PUBLIC

The list of frame IDs to select.
fiftyone.core.stages.SelectFrames.omit_empty

fiftyone.core.stages.SelectFrames.html#omit_empty

Attribute

Property

PUBLIC

Whether to omit samples that have no labels after filtering.
fiftyone.core.stages.SelectFrames.to_mongo

fiftyone.core.stages.SelectFrames.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.SelectFrames._kwargs

fiftyone.core.stages.SelectFrames.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.SelectFrames._params

fiftyone.core.stages.SelectFrames.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.SelectFrames._needs_frames

fiftyone.core.stages.SelectFrames.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.SelectFrames.validate

fiftyone.core.stages.SelectFrames.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.SelectGroups

fiftyone.core.stages.SelectGroups.html

Class

Class

PUBLIC

Selects the groups with the given IDs from a grouped collection.
fiftyone.core.stages.SelectGroups.__init__

fiftyone.core.stages.SelectGroups.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.SelectGroups._group_ids

fiftyone.core.stages.SelectGroups.html#_group_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectGroups._ordered

fiftyone.core.stages.SelectGroups.html#_ordered

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectGroups.group_ids

fiftyone.core.stages.SelectGroups.html#group_ids

Attribute

Property

PUBLIC

The list of group IDs to select.
fiftyone.core.stages.SelectGroups.ordered

fiftyone.core.stages.SelectGroups.html#ordered

Attribute

Property

PUBLIC

Whether to sort the groups in the same order as the IDs.
fiftyone.core.stages.SelectGroups.to_mongo

fiftyone.core.stages.SelectGroups.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.SelectGroups._kwargs

fiftyone.core.stages.SelectGroups.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.SelectGroups._params

fiftyone.core.stages.SelectGroups.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.SelectGroups.validate

fiftyone.core.stages.SelectGroups.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.SelectLabels

fiftyone.core.stages.SelectLabels.html

Class

Class

PUBLIC

Selects only the specified labels from a collection.
fiftyone.core.stages.SelectLabels.__init__

fiftyone.core.stages.SelectLabels.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.SelectLabels._labels

fiftyone.core.stages.SelectLabels.html#_labels

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectLabels._ids

fiftyone.core.stages.SelectLabels.html#_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectLabels._tags

fiftyone.core.stages.SelectLabels.html#_tags

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectLabels._fields

fiftyone.core.stages.SelectLabels.html#_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectLabels._omit_empty

fiftyone.core.stages.SelectLabels.html#_omit_empty

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectLabels._sample_ids

fiftyone.core.stages.SelectLabels.html#_sample_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectLabels._labels_map

fiftyone.core.stages.SelectLabels.html#_labels_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectLabels._pipeline

fiftyone.core.stages.SelectLabels.html#_pipeline

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SelectLabels.labels

fiftyone.core.stages.SelectLabels.html#labels

Attribute

Property

PUBLIC

A list of dicts specifying the labels to select.
fiftyone.core.stages.SelectLabels.ids

fiftyone.core.stages.SelectLabels.html#ids

Attribute

Property

PUBLIC

A list of IDs of labels to select.
fiftyone.core.stages.SelectLabels.tags

fiftyone.core.stages.SelectLabels.html#tags

Attribute

Property

PUBLIC

A list of tags of labels to select.
fiftyone.core.stages.SelectLabels.fields

fiftyone.core.stages.SelectLabels.html#fields

Attribute

Property

PUBLIC

A list of fields from which labels are being selected.
fiftyone.core.stages.SelectLabels.omit_empty

fiftyone.core.stages.SelectLabels.html#omit_empty

Attribute

Property

PUBLIC

Whether to omit samples that have no labels after filtering.
fiftyone.core.stages.SelectLabels.get_edited_fields

fiftyone.core.stages.SelectLabels.html#get_edited_fields

Function

Method

PUBLIC

Returns a list of names of fields or embedded fields that may have been edited by the stage, if any.
fiftyone.core.stages.SelectLabels.get_filtered_fields

fiftyone.core.stages.SelectLabels.html#get_filtered_fields

Function

Method

PUBLIC

Returns a list of names of fields or embedded fields that contain arrays have been filtered by the stage, if any.
fiftyone.core.stages.SelectLabels.to_mongo

fiftyone.core.stages.SelectLabels.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.SelectLabels._kwargs

fiftyone.core.stages.SelectLabels.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.SelectLabels._params

fiftyone.core.stages.SelectLabels.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.SelectLabels._needs_frames

fiftyone.core.stages.SelectLabels.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.SelectLabels._needs_group_slices

fiftyone.core.stages.SelectLabels.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.SelectLabels._make_labels_pipeline

fiftyone.core.stages.SelectLabels.html#_make_labels_pipeline

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.SelectLabels._make_pipeline

fiftyone.core.stages.SelectLabels.html#_make_pipeline

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.SelectLabels.validate

fiftyone.core.stages.SelectLabels.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.Shuffle

fiftyone.core.stages.Shuffle.html

Class

Class

PUBLIC

Randomly shuffles the samples in a collection.
fiftyone.core.stages.Shuffle.__init__

fiftyone.core.stages.Shuffle.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.Shuffle._seed

fiftyone.core.stages.Shuffle.html#_seed

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Shuffle._randint

fiftyone.core.stages.Shuffle.html#_randint

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Shuffle.seed

fiftyone.core.stages.Shuffle.html#seed

Attribute

Property

PUBLIC

The random seed to use, or None.
fiftyone.core.stages.Shuffle.to_mongo

fiftyone.core.stages.Shuffle.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.Shuffle._kwargs

fiftyone.core.stages.Shuffle.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.Shuffle._params

fiftyone.core.stages.Shuffle.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.Skip

fiftyone.core.stages.Skip.html

Class

Class

PUBLIC

Omits the given number of samples from the head of a collection.
fiftyone.core.stages.Skip.__init__

fiftyone.core.stages.Skip.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.Skip._skip

fiftyone.core.stages.Skip.html#_skip

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Skip.skip

fiftyone.core.stages.Skip.html#skip

Attribute

Property

PUBLIC

The number of samples to skip.
fiftyone.core.stages.Skip.to_mongo

fiftyone.core.stages.Skip.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.Skip._kwargs

fiftyone.core.stages.Skip.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.Skip._params

fiftyone.core.stages.Skip.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.SortBy

fiftyone.core.stages.SortBy.html

Class

Class

PUBLIC

Sorts the samples in a collection by the given field(s) or expression(s).
fiftyone.core.stages.SortBy.__init__

fiftyone.core.stages.SortBy.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.SortBy._field_or_expr

fiftyone.core.stages.SortBy.html#_field_or_expr

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SortBy._reverse

fiftyone.core.stages.SortBy.html#_reverse

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SortBy._create_index

fiftyone.core.stages.SortBy.html#_create_index

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SortBy.field_or_expr

fiftyone.core.stages.SortBy.html#field_or_expr

Attribute

Property

PUBLIC

The field or expression to sort by.
fiftyone.core.stages.SortBy.reverse

fiftyone.core.stages.SortBy.html#reverse

Attribute

Property

PUBLIC

Whether to return the results in descending order.
fiftyone.core.stages.SortBy.create_index

fiftyone.core.stages.SortBy.html#create_index

Attribute

Property

PUBLIC

Whether to create an index, if necessary, to optimize the sort.
fiftyone.core.stages.SortBy.to_mongo

fiftyone.core.stages.SortBy.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.SortBy._needs_frames

fiftyone.core.stages.SortBy.html#_needs_frames

Function

Method

PRIVATE

Whether the stage requires frame labels of video samples to be attached.
fiftyone.core.stages.SortBy._needs_group_slices

fiftyone.core.stages.SortBy.html#_needs_group_slices

Function

Method

PRIVATE

Whether the stage requires group slice(s) to be attached.
fiftyone.core.stages.SortBy._get_mongo_field_or_expr

fiftyone.core.stages.SortBy.html#_get_mongo_field_or_expr

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.SortBy._kwargs

fiftyone.core.stages.SortBy.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.SortBy._params

fiftyone.core.stages.SortBy.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.SortBy.validate

fiftyone.core.stages.SortBy.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages._serialize_sort_expr

fiftyone.core.stages.html#_serialize_sort_expr

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._parse_sort_order

fiftyone.core.stages.html#_parse_sort_order

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages.SortBySimilarity

fiftyone.core.stages.SortBySimilarity.html

Class

Class

PUBLIC

Sorts a collection by similarity to a specified query.
fiftyone.core.stages.SortBySimilarity.__init__

fiftyone.core.stages.SortBySimilarity.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.SortBySimilarity._query

fiftyone.core.stages.SortBySimilarity.html#_query

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SortBySimilarity._query_kwarg

fiftyone.core.stages.SortBySimilarity.html#_query_kwarg

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SortBySimilarity._is_prompt

fiftyone.core.stages.SortBySimilarity.html#_is_prompt

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SortBySimilarity._k

fiftyone.core.stages.SortBySimilarity.html#_k

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SortBySimilarity._reverse

fiftyone.core.stages.SortBySimilarity.html#_reverse

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SortBySimilarity._dist_field

fiftyone.core.stages.SortBySimilarity.html#_dist_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SortBySimilarity._brain_key

fiftyone.core.stages.SortBySimilarity.html#_brain_key

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SortBySimilarity._state

fiftyone.core.stages.SortBySimilarity.html#_state

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SortBySimilarity._pipeline

fiftyone.core.stages.SortBySimilarity.html#_pipeline

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.SortBySimilarity.query

fiftyone.core.stages.SortBySimilarity.html#query

Attribute

Property

PUBLIC

The query.
fiftyone.core.stages.SortBySimilarity.k

fiftyone.core.stages.SortBySimilarity.html#k

Attribute

Property

PUBLIC

The number of matches to return.
fiftyone.core.stages.SortBySimilarity.reverse

fiftyone.core.stages.SortBySimilarity.html#reverse

Attribute

Property

PUBLIC

Whether to sort by least similarity.
fiftyone.core.stages.SortBySimilarity.dist_field

fiftyone.core.stages.SortBySimilarity.html#dist_field

Attribute

Property

PUBLIC

The field to store similarity distances, if any.
fiftyone.core.stages.SortBySimilarity.brain_key

fiftyone.core.stages.SortBySimilarity.html#brain_key

Attribute

Property

PUBLIC

The brain key of the similarity index to use.
fiftyone.core.stages.SortBySimilarity.to_mongo

fiftyone.core.stages.SortBySimilarity.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.SortBySimilarity._kwargs

fiftyone.core.stages.SortBySimilarity.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.SortBySimilarity._params

fiftyone.core.stages.SortBySimilarity.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.SortBySimilarity.validate

fiftyone.core.stages.SortBySimilarity.html#validate

Function

Method

PUBLIC

Validates that the stage can be applied to the given collection.
fiftyone.core.stages.SortBySimilarity._make_pipeline

fiftyone.core.stages.SortBySimilarity.html#_make_pipeline

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages._parse_similarity_query

fiftyone.core.stages.html#_parse_similarity_query

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages.Take

fiftyone.core.stages.Take.html

Class

Class

PUBLIC

Randomly samples the given number of samples from a collection.
fiftyone.core.stages.Take.__init__

fiftyone.core.stages.Take.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.Take._seed

fiftyone.core.stages.Take.html#_seed

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Take._size

fiftyone.core.stages.Take.html#_size

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Take._randint

fiftyone.core.stages.Take.html#_randint

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.Take.size

fiftyone.core.stages.Take.html#size

Attribute

Property

PUBLIC

The number of samples to return.
fiftyone.core.stages.Take.seed

fiftyone.core.stages.Take.html#seed

Attribute

Property

PUBLIC

The random seed to use, or None.
fiftyone.core.stages.Take.to_mongo

fiftyone.core.stages.Take.html#to_mongo

Function

Method

PUBLIC

Returns the MongoDB aggregation pipeline for the stage.
fiftyone.core.stages.Take._kwargs

fiftyone.core.stages.Take.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.Take._params

fiftyone.core.stages.Take.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.ToPatches

fiftyone.core.stages.ToPatches.html

Class

Class

PUBLIC

Creates a view that contains one sample per object patch in the specified field of a collection.
fiftyone.core.stages.ToPatches.__init__

fiftyone.core.stages.ToPatches.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.ToPatches._field

fiftyone.core.stages.ToPatches.html#_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ToPatches._config

fiftyone.core.stages.ToPatches.html#_config

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ToPatches._state

fiftyone.core.stages.ToPatches.html#_state

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ToPatches.has_view

fiftyone.core.stages.ToPatches.html#has_view

Attribute

Property

PUBLIC

Whether this stage's output view should be loaded via load_view rather than appending stages to an aggregation pipeline via to_mongo.
fiftyone.core.stages.ToPatches.field

fiftyone.core.stages.ToPatches.html#field

Attribute

Property

PUBLIC

The patches field.
fiftyone.core.stages.ToPatches.config

fiftyone.core.stages.ToPatches.html#config

Attribute

Property

PUBLIC

Parameters specifying how to perform the conversion.
fiftyone.core.stages.ToPatches.load_view

fiftyone.core.stages.ToPatches.html#load_view

Function

Method

PUBLIC

Loads the fiftyone.core.view.DatasetView containing the output of the stage.
fiftyone.core.stages.ToPatches._kwargs

fiftyone.core.stages.ToPatches.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.ToPatches._params

fiftyone.core.stages.ToPatches.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.ToEvaluationPatches

fiftyone.core.stages.ToEvaluationPatches.html

Class

Class

PUBLIC

Creates a view based on the results of the evaluation with the given key that contains one sample for each true positive, false positive, and false negative example in the collection, respectively.
fiftyone.core.stages.ToEvaluationPatches.__init__

fiftyone.core.stages.ToEvaluationPatches.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.ToEvaluationPatches._eval_key

fiftyone.core.stages.ToEvaluationPatches.html#_eval_key

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ToEvaluationPatches._config

fiftyone.core.stages.ToEvaluationPatches.html#_config

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ToEvaluationPatches._state

fiftyone.core.stages.ToEvaluationPatches.html#_state

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ToEvaluationPatches.has_view

fiftyone.core.stages.ToEvaluationPatches.html#has_view

Attribute

Property

PUBLIC

Whether this stage's output view should be loaded via load_view rather than appending stages to an aggregation pipeline via to_mongo.
fiftyone.core.stages.ToEvaluationPatches.eval_key

fiftyone.core.stages.ToEvaluationPatches.html#eval_key

Attribute

Property

PUBLIC

The evaluation key to extract patches for.
fiftyone.core.stages.ToEvaluationPatches.config

fiftyone.core.stages.ToEvaluationPatches.html#config

Attribute

Property

PUBLIC

Parameters specifying how to perform the conversion.
fiftyone.core.stages.ToEvaluationPatches.load_view

fiftyone.core.stages.ToEvaluationPatches.html#load_view

Function

Method

PUBLIC

Loads the fiftyone.core.view.DatasetView containing the output of the stage.
fiftyone.core.stages.ToEvaluationPatches._kwargs

fiftyone.core.stages.ToEvaluationPatches.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.ToEvaluationPatches._params

fiftyone.core.stages.ToEvaluationPatches.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.ToClips

fiftyone.core.stages.ToClips.html

Class

Class

PUBLIC

Creates a view that contains one sample per clip defined by the given field or expression in a video collection.
fiftyone.core.stages.ToClips.__init__

fiftyone.core.stages.ToClips.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.ToClips._field_or_expr

fiftyone.core.stages.ToClips.html#_field_or_expr

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ToClips._config

fiftyone.core.stages.ToClips.html#_config

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ToClips._state

fiftyone.core.stages.ToClips.html#_state

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ToClips.has_view

fiftyone.core.stages.ToClips.html#has_view

Attribute

Property

PUBLIC

Whether this stage's output view should be loaded via load_view rather than appending stages to an aggregation pipeline via to_mongo.
fiftyone.core.stages.ToClips.field_or_expr

fiftyone.core.stages.ToClips.html#field_or_expr

Attribute

Property

PUBLIC

The field or expression defining how to extract the clips.
fiftyone.core.stages.ToClips.config

fiftyone.core.stages.ToClips.html#config

Attribute

Property

PUBLIC

Parameters specifying how to perform the conversion.
fiftyone.core.stages.ToClips.load_view

fiftyone.core.stages.ToClips.html#load_view

Function

Method

PUBLIC

Loads the fiftyone.core.view.DatasetView containing the output of the stage.
fiftyone.core.stages.ToClips._get_mongo_field_or_expr

fiftyone.core.stages.ToClips.html#_get_mongo_field_or_expr

Function

Method

PRIVATE

Undocumented
fiftyone.core.stages.ToClips._kwargs

fiftyone.core.stages.ToClips.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.ToClips._params

fiftyone.core.stages.ToClips.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.ToTrajectories

fiftyone.core.stages.ToTrajectories.html

Class

Class

PUBLIC

Creates a view that contains one clip for each unique object trajectory defined by their (label, index) in a frame-level field of a video collection.
fiftyone.core.stages.ToTrajectories.__init__

fiftyone.core.stages.ToTrajectories.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.ToTrajectories._field

fiftyone.core.stages.ToTrajectories.html#_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ToTrajectories._config

fiftyone.core.stages.ToTrajectories.html#_config

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ToTrajectories._state

fiftyone.core.stages.ToTrajectories.html#_state

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ToTrajectories.has_view

fiftyone.core.stages.ToTrajectories.html#has_view

Attribute

Property

PUBLIC

Whether this stage's output view should be loaded via load_view rather than appending stages to an aggregation pipeline via to_mongo.
fiftyone.core.stages.ToTrajectories.field

fiftyone.core.stages.ToTrajectories.html#field

Attribute

Property

PUBLIC

The label field for which to extract trajectories.
fiftyone.core.stages.ToTrajectories.config

fiftyone.core.stages.ToTrajectories.html#config

Attribute

Property

PUBLIC

Parameters specifying how to perform the conversion.
fiftyone.core.stages.ToTrajectories.load_view

fiftyone.core.stages.ToTrajectories.html#load_view

Function

Method

PUBLIC

Loads the fiftyone.core.view.DatasetView containing the output of the stage.
fiftyone.core.stages.ToTrajectories._kwargs

fiftyone.core.stages.ToTrajectories.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.ToTrajectories._params

fiftyone.core.stages.ToTrajectories.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages.ToFrames

fiftyone.core.stages.ToFrames.html

Class

Class

PUBLIC

Creates a view that contains one sample per frame in a video collection.
fiftyone.core.stages.ToFrames.__init__

fiftyone.core.stages.ToFrames.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages.ToFrames._config

fiftyone.core.stages.ToFrames.html#_config

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ToFrames._state

fiftyone.core.stages.ToFrames.html#_state

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.stages.ToFrames.has_view

fiftyone.core.stages.ToFrames.html#has_view

Attribute

Property

PUBLIC

Whether this stage's output view should be loaded via load_view rather than appending stages to an aggregation pipeline via to_mongo.
fiftyone.core.stages.ToFrames.config

fiftyone.core.stages.ToFrames.html#config

Attribute

Property

PUBLIC

Parameters specifying how to perform the conversion.
fiftyone.core.stages.ToFrames.load_view

fiftyone.core.stages.ToFrames.html#load_view

Function

Method

PUBLIC

Loads the fiftyone.core.view.DatasetView containing the output of the stage.
fiftyone.core.stages.ToFrames._kwargs

fiftyone.core.stages.ToFrames.html#_kwargs

Function

Method

PRIVATE

Returns a list of [name, value] lists describing the parameters of this stage instance.
fiftyone.core.stages.ToFrames._params

fiftyone.core.stages.ToFrames.html#_params

Function

Class Method

PRIVATE

Returns a list of JSON dicts describing the stage's supported parameters.
fiftyone.core.stages._parse_sample_ids

fiftyone.core.stages.html#_parse_sample_ids

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._parse_frame_ids

fiftyone.core.stages.html#_parse_frame_ids

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._parse_group_ids

fiftyone.core.stages.html#_parse_group_ids

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._get_group_id

fiftyone.core.stages.html#_get_group_id

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._get_rng

fiftyone.core.stages.html#_get_rng

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._parse_labels_field

fiftyone.core.stages.html#_parse_labels_field

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._remove_path_collisions

fiftyone.core.stages.html#_remove_path_collisions

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._merge_frame_paths

fiftyone.core.stages.html#_merge_frame_paths

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._parse_labels

fiftyone.core.stages.html#_parse_labels

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._get_label_field_only_matches_expr

fiftyone.core.stages.html#_get_label_field_only_matches_expr

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._make_omit_empty_labels_pipeline

fiftyone.core.stages.html#_make_omit_empty_labels_pipeline

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._make_match_empty_labels_pipeline

fiftyone.core.stages.html#_make_match_empty_labels_pipeline

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._get_default_similarity_run

fiftyone.core.stages.html#_get_default_similarity_run

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._get_selected_excluded_fields

fiftyone.core.stages.html#_get_selected_excluded_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.stages._ViewStageRepr

fiftyone.core.stages._ViewStageRepr.html

Class

Class

PRIVATE

Undocumented
fiftyone.core.stages._ViewStageRepr.repr_ViewExpression

fiftyone.core.stages._ViewStageRepr.html#repr_ViewExpression

Function

Method

PUBLIC

Undocumented
fiftyone.core.stages._repr

fiftyone.core.stages.html#_repr

Attribute

Variable

PRIVATE

Undocumented
fiftyone.core.stages._STAGES

fiftyone.core.stages.html#_STAGES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.stages._STAGES_THAT_SELECT_OR_REORDER

fiftyone.core.stages.html#_STAGES_THAT_SELECT_OR_REORDER

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.stages._STAGES_THAT_SELECT_FIRST

fiftyone.core.stages.html#_STAGES_THAT_SELECT_FIRST

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.json._MASK_CLASSES

fiftyone.core.json.html#_MASK_CLASSES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.json._handle_bytes

fiftyone.core.json.html#_handle_bytes

Function

Function

PRIVATE

Undocumented
fiftyone.core.json._handle_numpy_array

fiftyone.core.json.html#_handle_numpy_array

Function

Function

PRIVATE

Undocumented
fiftyone.core.json._handle_date

fiftyone.core.json.html#_handle_date

Function

Function

PRIVATE

Undocumented
fiftyone.core.json._is_invalid_number

fiftyone.core.json.html#_is_invalid_number

Function

Function

PRIVATE

Undocumented
fiftyone.core.json.stringify

fiftyone.core.json.html#stringify

Function

Function

PUBLIC

Converts unsafe JSON types to strings
fiftyone.core.utils.logger

fiftyone.core.utils.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.utils._REQUIREMENT_ERROR_SUFFIX

fiftyone.core.utils.html#_REQUIREMENT_ERROR_SUFFIX

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.utils.extract_kwargs_for_class

fiftyone.core.utils.html#extract_kwargs_for_class

Function

Function

PUBLIC

Extracts keyword arguments for the given class's constructor from the given kwargs.
fiftyone.core.utils.extract_kwargs_for_function

fiftyone.core.utils.html#extract_kwargs_for_function

Function

Function

PUBLIC

Extracts keyword arguments for the given function from the given kwargs.
fiftyone.core.utils._extract_kwargs

fiftyone.core.utils.html#_extract_kwargs

Function

Function

PRIVATE

Undocumented
fiftyone.core.utils.pprint

fiftyone.core.utils.html#pprint

Function

Function

PUBLIC

Pretty-prints the Python object.
fiftyone.core.utils.pformat

fiftyone.core.utils.html#pformat

Function

Function

PUBLIC

Returns a pretty string representation of the Python object.
fiftyone.core.utils.split_frame_fields

fiftyone.core.utils.html#split_frame_fields

Function

Function

PUBLIC

Splits the given fields into sample and frame fields.
fiftyone.core.utils._split_frame_fields_dict

fiftyone.core.utils.html#_split_frame_fields_dict

Function

Function

PRIVATE

Undocumented
fiftyone.core.utils.stream_objects

fiftyone.core.utils.html#stream_objects

Function

Function

PUBLIC

Streams the iterable of objects to stdout via less.
fiftyone.core.utils.indent_lines

fiftyone.core.utils.html#indent_lines

Function

Function

PUBLIC

Indents the lines in the given string.
fiftyone.core.utils.justify_headings

fiftyone.core.utils.html#justify_headings

Function

Function

PUBLIC

Justifies the headings in a list of (heading, content) string tuples by appending whitespace as necessary to each heading.
fiftyone.core.utils.available_patterns

fiftyone.core.utils.html#available_patterns

Function

Function

PUBLIC

Returns the available patterns that can be used by fill_patterns.
fiftyone.core.utils.fill_patterns

fiftyone.core.utils.html#fill_patterns

Function

Function

PUBLIC

Fills the patterns in in the given string.
fiftyone.core.utils.find_files

fiftyone.core.utils.html#find_files

Function

Function

PUBLIC

Finds all files in the given root directory whose filename matches the given glob pattern(s).
fiftyone.core.utils.install_package

fiftyone.core.utils.html#install_package

Function

Function

PUBLIC

Installs the given package via pip.
fiftyone.core.utils.ensure_package

fiftyone.core.utils.html#ensure_package

Function

Function

PUBLIC

Verifies that the given package is installed.
fiftyone.core.utils.load_requirements

fiftyone.core.utils.html#load_requirements

Function

Function

PUBLIC

Loads the package requirements from a requirements.txt file on disk.
fiftyone.core.utils._strip_comments

fiftyone.core.utils.html#_strip_comments

Function

Function

PRIVATE

Undocumented
fiftyone.core.utils.install_requirements

fiftyone.core.utils.html#install_requirements

Function

Function

PUBLIC

Installs the package requirements from a requirements.txt file on disk.
fiftyone.core.utils.ensure_requirements

fiftyone.core.utils.html#ensure_requirements

Function

Function

PUBLIC

Verifies that the package requirements from a requirements.txt file on disk are installed.
fiftyone.core.utils.ensure_import

fiftyone.core.utils.html#ensure_import

Function

Function

PUBLIC

Verifies that the given requirement is installed and importable.
fiftyone.core.utils.ensure_tf

fiftyone.core.utils.html#ensure_tf

Function

Function

PUBLIC

Verifies that tensorflow is installed and importable.
fiftyone.core.utils.ensure_tfds

fiftyone.core.utils.html#ensure_tfds

Function

Function

PUBLIC

Verifies that tensorflow_datasets is installed and importable.
fiftyone.core.utils.ensure_torch

fiftyone.core.utils.html#ensure_torch

Function

Function

PUBLIC

Verifies that torch and torchvision are installed and importable.
fiftyone.core.utils.handle_error

fiftyone.core.utils.html#handle_error

Function

Function

PUBLIC

Handles the error at the specified error level.
fiftyone.core.utils.LoggingLevel

fiftyone.core.utils.LoggingLevel.html

Class

Class

PUBLIC

Context manager that allows for a temporary change to the level of a logging.Logger.
fiftyone.core.utils.LoggingLevel.__init__

fiftyone.core.utils.LoggingLevel.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.LoggingLevel._logger

fiftyone.core.utils.LoggingLevel.html#_logger

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.LoggingLevel._level

fiftyone.core.utils.LoggingLevel.html#_level

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.LoggingLevel._level_orig

fiftyone.core.utils.LoggingLevel.html#_level_orig

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.LoggingLevel.__enter__

fiftyone.core.utils.LoggingLevel.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.LoggingLevel.__exit__

fiftyone.core.utils.LoggingLevel.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.lazy_import

fiftyone.core.utils.html#lazy_import

Function

Function

PUBLIC

Returns a proxy module object that will lazily import the given module the first time it is used.
fiftyone.core.utils.LazyModule

fiftyone.core.utils.LazyModule.html

Class

Class

PUBLIC

Proxy module that lazily imports the underlying module the first time it is actually used.
fiftyone.core.utils.LazyModule.__init__

fiftyone.core.utils.LazyModule.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.LazyModule._module

fiftyone.core.utils.LazyModule.html#_module

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.LazyModule._callback

fiftyone.core.utils.LazyModule.html#_callback

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.LazyModule.__getattr__

fiftyone.core.utils.LazyModule.html#__getattr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.LazyModule.__dir__

fiftyone.core.utils.LazyModule.html#__dir__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.LazyModule._import_module

fiftyone.core.utils.LazyModule.html#_import_module

Function

Method

PRIVATE

Undocumented
fiftyone.core.utils.load_xml_as_json_dict

fiftyone.core.utils.html#load_xml_as_json_dict

Function

Function

PUBLIC

Loads the XML file as a JSON dictionary.
fiftyone.core.utils.parse_serializable

fiftyone.core.utils.html#parse_serializable

Function

Function

PUBLIC

Parses the given object as an instance of the given eta.core.serial.Serializable class.
fiftyone.core.utils.set_resource_limit

fiftyone.core.utils.html#set_resource_limit

Function

Function

PUBLIC

Uses the resource package to change a resource limit for the current process.
fiftyone.core.utils.ResourceLimit

fiftyone.core.utils.ResourceLimit.html

Class

Class

PUBLIC

Context manager that allows for a temporary change to a resource limit exposed by the resource package.
fiftyone.core.utils.ResourceLimit.__init__

fiftyone.core.utils.ResourceLimit.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.ResourceLimit._supported_platform

fiftyone.core.utils.ResourceLimit.html#_supported_platform

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.ResourceLimit._limit

fiftyone.core.utils.ResourceLimit.html#_limit

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.ResourceLimit._soft

fiftyone.core.utils.ResourceLimit.html#_soft

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.ResourceLimit._hard

fiftyone.core.utils.ResourceLimit.html#_hard

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.ResourceLimit._soft_orig

fiftyone.core.utils.ResourceLimit.html#_soft_orig

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.ResourceLimit._hard_orig

fiftyone.core.utils.ResourceLimit.html#_hard_orig

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.ResourceLimit._warn_on_failure

fiftyone.core.utils.ResourceLimit.html#_warn_on_failure

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.ResourceLimit.__enter__

fiftyone.core.utils.ResourceLimit.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.ResourceLimit.__exit__

fiftyone.core.utils.ResourceLimit.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.ProgressBar

fiftyone.core.utils.ProgressBar.html

Class

Class

PUBLIC

No summary
fiftyone.core.utils.ProgressBar.__init__

fiftyone.core.utils.ProgressBar.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.ProgressBar._progress

fiftyone.core.utils.ProgressBar.html#_progress

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.ProgressBar._callback

fiftyone.core.utils.ProgressBar.html#_callback

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.ProgressBar.set_iteration

fiftyone.core.utils.ProgressBar.html#set_iteration

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.report_progress

fiftyone.core.utils.html#report_progress

Function

Function

PUBLIC

Wraps the provided progress function such that it will only be called at the specified increments or time intervals.
fiftyone.core.utils._report_progress_n

fiftyone.core.utils.html#_report_progress_n

Function

Function

PRIVATE

Undocumented
fiftyone.core.utils._report_progress_dt

fiftyone.core.utils.html#_report_progress_dt

Function

Function

PRIVATE

Undocumented
fiftyone.core.utils.Batcher

fiftyone.core.utils.Batcher.html

Class

Class

PUBLIC

Base class for iterating over the elements of an iterable in batches.
fiftyone.core.utils.Batcher.manual_backpressure

fiftyone.core.utils.Batcher.html#manual_backpressure

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.utils.Batcher.__init__

fiftyone.core.utils.Batcher.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.Batcher.iterable

fiftyone.core.utils.Batcher.html#iterable

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.Batcher.return_views

fiftyone.core.utils.Batcher.html#return_views

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.Batcher.progress

fiftyone.core.utils.Batcher.html#progress

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.Batcher.total

fiftyone.core.utils.Batcher.html#total

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.Batcher._iter

fiftyone.core.utils.Batcher.html#_iter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.Batcher._last_batch_size

fiftyone.core.utils.Batcher.html#_last_batch_size

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.Batcher._pb

fiftyone.core.utils.Batcher.html#_pb

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.Batcher._in_context

fiftyone.core.utils.Batcher.html#_in_context

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.Batcher._render_progress

fiftyone.core.utils.Batcher.html#_render_progress

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.Batcher._last_offset

fiftyone.core.utils.Batcher.html#_last_offset

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.Batcher._num_samples

fiftyone.core.utils.Batcher.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.Batcher._manually_applied_backpressure

fiftyone.core.utils.Batcher.html#_manually_applied_backpressure

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.Batcher.__enter__

fiftyone.core.utils.Batcher.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.Batcher.__exit__

fiftyone.core.utils.Batcher.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.Batcher.__iter__

fiftyone.core.utils.Batcher.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.Batcher.__next__

fiftyone.core.utils.Batcher.html#__next__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.Batcher.apply_backpressure

fiftyone.core.utils.Batcher.html#apply_backpressure

Function

Method

PUBLIC

Apply backpressure needed to rightsize the next batch.
fiftyone.core.utils.Batcher._compute_batch_size

fiftyone.core.utils.Batcher.html#_compute_batch_size

Function

Method

PRIVATE

Return next batch size. Concrete classes must implement.
fiftyone.core.utils.BaseDynamicBatcher

fiftyone.core.utils.BaseDynamicBatcher.html

Class

Class

PUBLIC

Class for iterating over the elements of an iterable with a dynamic batch size to achieve a desired target measurement.
fiftyone.core.utils.BaseDynamicBatcher.__init__

fiftyone.core.utils.BaseDynamicBatcher.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.BaseDynamicBatcher.target_measurement

fiftyone.core.utils.BaseDynamicBatcher.html#target_measurement

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.BaseDynamicBatcher.init_batch_size

fiftyone.core.utils.BaseDynamicBatcher.html#init_batch_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.BaseDynamicBatcher.min_batch_size

fiftyone.core.utils.BaseDynamicBatcher.html#min_batch_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.BaseDynamicBatcher.max_batch_size

fiftyone.core.utils.BaseDynamicBatcher.html#max_batch_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.BaseDynamicBatcher.max_batch_beta

fiftyone.core.utils.BaseDynamicBatcher.html#max_batch_beta

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.BaseDynamicBatcher._compute_batch_size

fiftyone.core.utils.BaseDynamicBatcher.html#_compute_batch_size

Function

Method

PRIVATE

Return next batch size. Concrete classes must implement.
fiftyone.core.utils.BaseDynamicBatcher._last_batch_size

fiftyone.core.utils.BaseDynamicBatcher.html#_last_batch_size

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.BaseDynamicBatcher._get_measurement

fiftyone.core.utils.BaseDynamicBatcher.html#_get_measurement

Function

Method

PRIVATE

Get backpressure measurement for current batch.
fiftyone.core.utils.LatencyDynamicBatcher

fiftyone.core.utils.LatencyDynamicBatcher.html

Class

Class

PUBLIC

Class for iterating over the elements of an iterable with a dynamic batch size to achieve a desired latency.
fiftyone.core.utils.LatencyDynamicBatcher.__init__

fiftyone.core.utils.LatencyDynamicBatcher.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.LatencyDynamicBatcher._last_time

fiftyone.core.utils.LatencyDynamicBatcher.html#_last_time

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.LatencyDynamicBatcher._get_measurement

fiftyone.core.utils.LatencyDynamicBatcher.html#_get_measurement

Function

Method

PRIVATE

Get backpressure measurement for current batch.
fiftyone.core.utils.ContentSizeDynamicBatcher

fiftyone.core.utils.ContentSizeDynamicBatcher.html

Class

Class

PUBLIC

Class for iterating over the elements of an iterable with a dynamic batch size to achieve a desired content size.
fiftyone.core.utils.ContentSizeDynamicBatcher.manual_backpressure

fiftyone.core.utils.ContentSizeDynamicBatcher.html#manual_backpressure

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.utils.ContentSizeDynamicBatcher.__init__

fiftyone.core.utils.ContentSizeDynamicBatcher.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.ContentSizeDynamicBatcher._last_batch_content_size

fiftyone.core.utils.ContentSizeDynamicBatcher.html#_last_batch_content_size

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.ContentSizeDynamicBatcher.apply_backpressure

fiftyone.core.utils.ContentSizeDynamicBatcher.html#apply_backpressure

Function

Method

PUBLIC

Apply backpressure needed to rightsize the next batch.
fiftyone.core.utils.ContentSizeDynamicBatcher._manually_applied_backpressure

fiftyone.core.utils.ContentSizeDynamicBatcher.html#_manually_applied_backpressure

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.ContentSizeDynamicBatcher._get_measurement

fiftyone.core.utils.ContentSizeDynamicBatcher.html#_get_measurement

Function

Method

PRIVATE

Get backpressure measurement for current batch.
fiftyone.core.utils.StaticBatcher

fiftyone.core.utils.StaticBatcher.html

Class

Class

PUBLIC

Class for iterating over the elements of an iterable with a static batch size.
fiftyone.core.utils.StaticBatcher.__init__

fiftyone.core.utils.StaticBatcher.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.StaticBatcher.batch_size

fiftyone.core.utils.StaticBatcher.html#batch_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.StaticBatcher._compute_batch_size

fiftyone.core.utils.StaticBatcher.html#_compute_batch_size

Function

Method

PRIVATE

Return next batch size. Concrete classes must implement.
fiftyone.core.utils.get_default_batcher

fiftyone.core.utils.html#get_default_batcher

Function

Function

PUBLIC

Returns a Batcher over iterable using defaults from your FiftyOne config.
fiftyone.core.utils.parse_batching_strategy

fiftyone.core.utils.html#parse_batching_strategy

Function

Function

PUBLIC

Parses the given batching strategy configuration, applying any default config settings as necessary.
fiftyone.core.utils.recommend_batch_size_for_value

fiftyone.core.utils.html#recommend_batch_size_for_value

Function

Function

PUBLIC

Computes a recommended batch size for the given value type such that a request involving a list of values of this size will be less than alpha * fo.config.batcher_target_size_bytes bytes.
fiftyone.core.utils.disable_progress_bars

fiftyone.core.utils.html#disable_progress_bars

Function

Function

PUBLIC

Context manager that temporarily disables all progress bars.
fiftyone.core.utils.UniqueFilenameMaker

fiftyone.core.utils.UniqueFilenameMaker.html

Class

Class

PUBLIC

A class that generates unique output paths in a directory.
fiftyone.core.utils.UniqueFilenameMaker.output_dir

fiftyone.core.utils.UniqueFilenameMaker.html#output_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.UniqueFilenameMaker.rel_dir

fiftyone.core.utils.UniqueFilenameMaker.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.UniqueFilenameMaker.alt_dir

fiftyone.core.utils.UniqueFilenameMaker.html#alt_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.UniqueFilenameMaker.chunk_size

fiftyone.core.utils.UniqueFilenameMaker.html#chunk_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.UniqueFilenameMaker.default_ext

fiftyone.core.utils.UniqueFilenameMaker.html#default_ext

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.UniqueFilenameMaker.ignore_exts

fiftyone.core.utils.UniqueFilenameMaker.html#ignore_exts

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.UniqueFilenameMaker.ignore_existing

fiftyone.core.utils.UniqueFilenameMaker.html#ignore_existing

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.UniqueFilenameMaker.idempotent

fiftyone.core.utils.UniqueFilenameMaker.html#idempotent

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.UniqueFilenameMaker.__init__

fiftyone.core.utils.UniqueFilenameMaker.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.UniqueFilenameMaker._filepath_map

fiftyone.core.utils.UniqueFilenameMaker.html#_filepath_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.UniqueFilenameMaker._filename_counts

fiftyone.core.utils.UniqueFilenameMaker.html#_filename_counts

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.UniqueFilenameMaker._default_filename_patt

fiftyone.core.utils.UniqueFilenameMaker.html#_default_filename_patt

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.UniqueFilenameMaker._idx

fiftyone.core.utils.UniqueFilenameMaker.html#_idx

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.UniqueFilenameMaker._chunk_root

fiftyone.core.utils.UniqueFilenameMaker.html#_chunk_root

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.UniqueFilenameMaker._chunk_num

fiftyone.core.utils.UniqueFilenameMaker.html#_chunk_num

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.UniqueFilenameMaker._chunk_count

fiftyone.core.utils.UniqueFilenameMaker.html#_chunk_count

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.UniqueFilenameMaker._setup

fiftyone.core.utils.UniqueFilenameMaker.html#_setup

Function

Method

PRIVATE

Undocumented
fiftyone.core.utils.UniqueFilenameMaker.seen_input_path

fiftyone.core.utils.UniqueFilenameMaker.html#seen_input_path

Function

Method

PUBLIC

Checks whether we've already seen the given input path.
fiftyone.core.utils.UniqueFilenameMaker.get_output_path

fiftyone.core.utils.UniqueFilenameMaker.html#get_output_path

Function

Method

PUBLIC

Returns a unique output path.
fiftyone.core.utils.UniqueFilenameMaker.get_alt_path

fiftyone.core.utils.UniqueFilenameMaker.html#get_alt_path

Function

Method

PUBLIC

Returns the alternate path for the given output path generated by get_output_path.
fiftyone.core.utils.safe_relpath

fiftyone.core.utils.html#safe_relpath

Function

Function

PUBLIC

A safe version of os.path.relpath that returns a configurable default value if the given path if it does not lie within the given relative start.
fiftyone.core.utils.compute_filehash

fiftyone.core.utils.html#compute_filehash

Function

Function

PUBLIC

Computes the hash of the given file.
fiftyone.core.utils.serialize_numpy_array

fiftyone.core.utils.html#serialize_numpy_array

Function

Function

PUBLIC

Serializes a numpy array.
fiftyone.core.utils.deserialize_numpy_array

fiftyone.core.utils.html#deserialize_numpy_array

Function

Function

PUBLIC

Loads a serialized numpy array generated by serialize_numpy_array.
fiftyone.core.utils.iter_batches

fiftyone.core.utils.html#iter_batches

Function

Function

PUBLIC

Iterates over the given iterable in batches.
fiftyone.core.utils.iter_slices

fiftyone.core.utils.html#iter_slices

Function

Function

PUBLIC

Iterates over batches of the given object via slicing.
fiftyone.core.utils.call_on_exit

fiftyone.core.utils.html#call_on_exit

Function

Function

PUBLIC

Registers the given callback function so that it will be called when the process exits for (almost) any reason
fiftyone.core.utils.MonkeyPatchFunction

fiftyone.core.utils.MonkeyPatchFunction.html

Class

Class

PUBLIC

Context manager that temporarily monkey patches the given function.
fiftyone.core.utils.MonkeyPatchFunction.fcn_name

fiftyone.core.utils.MonkeyPatchFunction.html#fcn_name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.MonkeyPatchFunction.namespace

fiftyone.core.utils.MonkeyPatchFunction.html#namespace

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.MonkeyPatchFunction.__init__

fiftyone.core.utils.MonkeyPatchFunction.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.MonkeyPatchFunction.module

fiftyone.core.utils.MonkeyPatchFunction.html#module

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.MonkeyPatchFunction.monkey_fcn

fiftyone.core.utils.MonkeyPatchFunction.html#monkey_fcn

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.MonkeyPatchFunction._orig

fiftyone.core.utils.MonkeyPatchFunction.html#_orig

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.MonkeyPatchFunction._replace_modules

fiftyone.core.utils.MonkeyPatchFunction.html#_replace_modules

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.MonkeyPatchFunction.__enter__

fiftyone.core.utils.MonkeyPatchFunction.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.MonkeyPatchFunction.__exit__

fiftyone.core.utils.MonkeyPatchFunction.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.MonkeyPatchFunction._set

fiftyone.core.utils.MonkeyPatchFunction.html#_set

Function

Method

PRIVATE

Undocumented
fiftyone.core.utils.MonkeyPatchFunction._find

fiftyone.core.utils.MonkeyPatchFunction.html#_find

Function

Method

PRIVATE

Undocumented
fiftyone.core.utils.SetAttributes

fiftyone.core.utils.SetAttributes.html

Class

Class

PUBLIC

Context manager that temporarily sets the attributes of a class to new values.
fiftyone.core.utils.SetAttributes.__init__

fiftyone.core.utils.SetAttributes.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.SetAttributes._obj

fiftyone.core.utils.SetAttributes.html#_obj

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.SetAttributes._kwargs

fiftyone.core.utils.SetAttributes.html#_kwargs

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.SetAttributes._orig_kwargs

fiftyone.core.utils.SetAttributes.html#_orig_kwargs

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.SetAttributes._new_kwargs

fiftyone.core.utils.SetAttributes.html#_new_kwargs

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.SetAttributes.__enter__

fiftyone.core.utils.SetAttributes.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.SetAttributes.__exit__

fiftyone.core.utils.SetAttributes.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.SuppressLogging

fiftyone.core.utils.SuppressLogging.html

Class

Class

PUBLIC

Context manager that temporarily disables system-wide logging.
fiftyone.core.utils.SuppressLogging.level

fiftyone.core.utils.SuppressLogging.html#level

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.SuppressLogging.__init__

fiftyone.core.utils.SuppressLogging.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.SuppressLogging.__enter__

fiftyone.core.utils.SuppressLogging.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.SuppressLogging.__exit__

fiftyone.core.utils.SuppressLogging.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.add_sys_path

fiftyone.core.utils.add_sys_path.html

Class

Class

PUBLIC

Context manager that temporarily inserts a path to sys.path.
fiftyone.core.utils.add_sys_path.__init__

fiftyone.core.utils.add_sys_path.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.add_sys_path.path

fiftyone.core.utils.add_sys_path.html#path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.add_sys_path.index

fiftyone.core.utils.add_sys_path.html#index

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.utils.add_sys_path.__enter__

fiftyone.core.utils.add_sys_path.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.add_sys_path.__exit__

fiftyone.core.utils.add_sys_path.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.is_arm_mac

fiftyone.core.utils.html#is_arm_mac

Function

Function

PUBLIC

Determines whether the system is an ARM-based Mac (Apple Silicon).
fiftyone.core.utils.is_32_bit

fiftyone.core.utils.html#is_32_bit

Function

Function

PUBLIC

Determines whether the system is 32-bit.
fiftyone.core.utils.is_container

fiftyone.core.utils.html#is_container

Function

Function

PUBLIC

Determines if we're currently running as a container.
fiftyone.core.utils._is_docker

fiftyone.core.utils.html#_is_docker

Function

Function

PRIVATE

Undocumented
fiftyone.core.utils._is_podman

fiftyone.core.utils.html#_is_podman

Function

Function

PRIVATE

Undocumented
fiftyone.core.utils.get_multiprocessing_context

fiftyone.core.utils.html#get_multiprocessing_context

Function

Function

PUBLIC

Returns the preferred multiprocessing context for the current OS.
fiftyone.core.utils.recommend_thread_pool_workers

fiftyone.core.utils.html#recommend_thread_pool_workers

Function

Function

PUBLIC

Recommends a number of workers for a thread pool.
fiftyone.core.utils.recommend_process_pool_workers

fiftyone.core.utils.html#recommend_process_pool_workers

Function

Function

PUBLIC

Recommends a number of workers for a process pool.
fiftyone.core.utils.sync_task_executor

fiftyone.core.utils.html#sync_task_executor

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.utils._get_sync_task_executor

fiftyone.core.utils.html#_get_sync_task_executor

Function

Function

PRIVATE

Undocumented
fiftyone.core.utils.run_sync_task

fiftyone.core.utils.html#run_sync_task

Function

Function

PUBLIC

Run a synchronous function as an async background task.
fiftyone.core.utils.datetime_to_timestamp

fiftyone.core.utils.html#datetime_to_timestamp

Function

Function

PUBLIC

Converts a datetime.date or datetime.datetime to milliseconds since epoch.
fiftyone.core.utils.timestamp_to_datetime

fiftyone.core.utils.html#timestamp_to_datetime

Function

Function

PUBLIC

Converts a timestamp (number of milliseconds since epoch) to a datetime.datetime.
fiftyone.core.utils.timedelta_to_ms

fiftyone.core.utils.html#timedelta_to_ms

Function

Function

PUBLIC

Converts a datetime.timedelta to milliseconds.
fiftyone.core.utils.ResponseStream

fiftyone.core.utils.ResponseStream.html

Class

Class

PUBLIC

Wrapper around a requests.Response that provides a file-like object interface with read(), seek(), and tell() methods.
fiftyone.core.utils.ResponseStream.__init__

fiftyone.core.utils.ResponseStream.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.ResponseStream._response

fiftyone.core.utils.ResponseStream.html#_response

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.ResponseStream._iterator

fiftyone.core.utils.ResponseStream.html#_iterator

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.ResponseStream._bytes

fiftyone.core.utils.ResponseStream.html#_bytes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.utils.ResponseStream.read

fiftyone.core.utils.ResponseStream.html#read

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.ResponseStream.seek

fiftyone.core.utils.ResponseStream.html#seek

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.ResponseStream.tell

fiftyone.core.utils.ResponseStream.html#tell

Function

Method

PUBLIC

Undocumented
fiftyone.core.utils.ResponseStream._load_all

fiftyone.core.utils.ResponseStream.html#_load_all

Function

Method

PRIVATE

Undocumented
fiftyone.core.utils.ResponseStream._load_until

fiftyone.core.utils.ResponseStream.html#_load_until

Function

Method

PRIVATE

Undocumented
fiftyone.core.utils._SAFE_CHARS

fiftyone.core.utils.html#_SAFE_CHARS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.utils._HYPHEN_CHARS

fiftyone.core.utils.html#_HYPHEN_CHARS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.utils._NAME_LENGTH_RANGE

fiftyone.core.utils.html#_NAME_LENGTH_RANGE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.utils._sanitize_char

fiftyone.core.utils.html#_sanitize_char

Function

Function

PRIVATE

Undocumented
fiftyone.core.utils.to_slug

fiftyone.core.utils.html#to_slug

Function

Function

PUBLIC

Returns the URL-friendly slug for the given string.
fiftyone.core.utils.validate_color

fiftyone.core.utils.html#validate_color

Function

Function

PUBLIC

Validates that the given value is a valid css color name.
fiftyone.core.utils.validate_hex_color

fiftyone.core.utils.html#validate_hex_color

Function

Function

PUBLIC

Validates that the given value is a hex color string or css name.
fiftyone.core.utils.fos

fiftyone.core.utils.html#fos

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.scalars.BSON

fiftyone.server.scalars.html#BSON

Attribute

Constant

PUBLIC

Undocumented
fiftyone.server.scalars.BSONArray

fiftyone.server.scalars.html#BSONArray

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.scalars.JSON

fiftyone.server.scalars.html#JSON

Attribute

Constant

PUBLIC

Undocumented
fiftyone.server.scalars.JSONArray

fiftyone.server.scalars.html#JSONArray

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.scalars.DateTime

fiftyone.server.scalars.html#DateTime

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.scalars.Date

fiftyone.server.scalars.html#Date

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.state.logger

fiftyone.core.state.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.state.StateDescription

fiftyone.core.state.StateDescription.html

Class

Class

PUBLIC

Class that describes the shared state between the FiftyOne App and a corresponding fiftyone.core.session.Session.
fiftyone.core.state.StateDescription.color_scheme

fiftyone.core.state.StateDescription.html#color_scheme

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.state.StateDescription.config

fiftyone.core.state.StateDescription.html#config

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.state.StateDescription.dataset

fiftyone.core.state.StateDescription.html#dataset

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.state.StateDescription.field_visibility_stage

fiftyone.core.state.StateDescription.html#field_visibility_stage

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.state.StateDescription.group_id

fiftyone.core.state.StateDescription.html#group_id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.state.StateDescription.group_slice

fiftyone.core.state.StateDescription.html#group_slice

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.state.StateDescription.sample_id

fiftyone.core.state.StateDescription.html#sample_id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.state.StateDescription.selected

fiftyone.core.state.StateDescription.html#selected

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.state.StateDescription.selected_labels

fiftyone.core.state.StateDescription.html#selected_labels

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.state.StateDescription.spaces

fiftyone.core.state.StateDescription.html#spaces

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.state.StateDescription.view

fiftyone.core.state.StateDescription.html#view

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.state.StateDescription.__init__

fiftyone.core.state.StateDescription.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.state.StateDescription.serialize

fiftyone.core.state.StateDescription.html#serialize

Function

Method

PUBLIC

Undocumented
fiftyone.core.state.StateDescription.attributes

fiftyone.core.state.StateDescription.html#attributes

Function

Method

PUBLIC

Undocumented
fiftyone.core.state.StateDescription.from_dict

fiftyone.core.state.StateDescription.html#from_dict

Function

Class Method

PUBLIC

Constructs a StateDescription from a JSON dictionary.
fiftyone.core.state.SampleField

fiftyone.core.state.SampleField.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.state.SampleField.ftype

fiftyone.core.state.SampleField.html#ftype

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.state.SampleField.path

fiftyone.core.state.SampleField.html#path

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.state.SampleField.subfield

fiftyone.core.state.SampleField.html#subfield

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.state.SampleField.embedded_doc_type

fiftyone.core.state.SampleField.html#embedded_doc_type

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.state.SampleField.db_field

fiftyone.core.state.SampleField.html#db_field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.state.SampleField.description

fiftyone.core.state.SampleField.html#description

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.state.SampleField.info

fiftyone.core.state.SampleField.html#info

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.state.serialize_fields

fiftyone.core.state.html#serialize_fields

Function

Function

PUBLIC

Undocumented
fiftyone.core.state._convert_mongoengine_data

fiftyone.core.state.html#_convert_mongoengine_data

Function

Function

PRIVATE

Undocumented
fiftyone.core.state.build_color_scheme

fiftyone.core.state.html#build_color_scheme

Function

Function

PUBLIC

Undocumented
fiftyone.core.session.events.fop

fiftyone.core.session.events.html#fop

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.session.events.EventType

fiftyone.core.session.events.html#EventType

Attribute

Type Alias

PUBLIC

Undocumented
fiftyone.core.session.events._camel_to_snake

fiftyone.core.session.events.html#_camel_to_snake

Attribute

Variable

PRIVATE

Undocumented
fiftyone.core.session.events._SCREENSHOTS

fiftyone.core.session.events.html#_SCREENSHOTS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.session.events.Event

fiftyone.core.session.events.Event.html

Class

Class

PUBLIC

Base server event
fiftyone.core.session.events.Event.get_event_name

fiftyone.core.session.events.Event.html#get_event_name

Function

Class Method

PUBLIC

Undocumented
fiftyone.core.session.events.Event.from_data

fiftyone.core.session.events.Event.html#from_data

Function

Static Method

PUBLIC

Undocumented
fiftyone.core.session.events.Event.from_data_async

fiftyone.core.session.events.Event.html#from_data_async

Function

Static Method

PUBLIC

Undocumented
fiftyone.core.session.events.Event.serialize

fiftyone.core.session.events.Event.html#serialize

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.events.LabelData

fiftyone.core.session.events.LabelData.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.session.events.LabelData.label_id

fiftyone.core.session.events.LabelData.html#label_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.LabelData.field

fiftyone.core.session.events.LabelData.html#field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.LabelData.sample_id

fiftyone.core.session.events.LabelData.html#sample_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.LabelData.frame_number

fiftyone.core.session.events.LabelData.html#frame_number

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.Screenshot

fiftyone.core.session.events.Screenshot.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.session.events.Screenshot.bytes

fiftyone.core.session.events.Screenshot.html#bytes

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.Screenshot.max_width

fiftyone.core.session.events.Screenshot.html#max_width

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.CaptureNotebookCell

fiftyone.core.session.events.CaptureNotebookCell.html

Class

Class

PUBLIC

Capture notebook cell screenshot event
fiftyone.core.session.events.CaptureNotebookCell.subscription

fiftyone.core.session.events.CaptureNotebookCell.html#subscription

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.CaptureNotebookCell.src

fiftyone.core.session.events.CaptureNotebookCell.html#src

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.CaptureNotebookCell.width

fiftyone.core.session.events.CaptureNotebookCell.html#width

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.CloseSession

fiftyone.core.session.events.CloseSession.html

Class

Class

PUBLIC

Close session event
fiftyone.core.session.events.DeactivateNotebookCell

fiftyone.core.session.events.DeactivateNotebookCell.html

Class

Class

PUBLIC

Deactivate notebook cell event
fiftyone.core.session.events.Ping

fiftyone.core.session.events.Ping.html

Class

Class

PUBLIC

Ping (builtin) event
fiftyone.core.session.events.ReactivateNotebookCell

fiftyone.core.session.events.ReactivateNotebookCell.html

Class

Class

PUBLIC

Reactivate notebook cell event
fiftyone.core.session.events.ReactivateNotebookCell.subscription

fiftyone.core.session.events.ReactivateNotebookCell.html#subscription

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.Refresh

fiftyone.core.session.events.Refresh.html

Class

Class

PUBLIC

Refresh event
fiftyone.core.session.events.Refresh.state

fiftyone.core.session.events.Refresh.html#state

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.SelectLabels

fiftyone.core.session.events.SelectLabels.html

Class

Class

PUBLIC

Select labels event
fiftyone.core.session.events.SelectLabels.labels

fiftyone.core.session.events.SelectLabels.html#labels

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.SelectSamples

fiftyone.core.session.events.SelectSamples.html

Class

Class

PUBLIC

Select samples event
fiftyone.core.session.events.SelectSamples.sample_ids

fiftyone.core.session.events.SelectSamples.html#sample_ids

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ValueColor

fiftyone.core.session.events.ValueColor.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.session.events.ValueColor.color

fiftyone.core.session.events.ValueColor.html#color

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ValueColor.value

fiftyone.core.session.events.ValueColor.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.MaskColor

fiftyone.core.session.events.MaskColor.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.session.events.MaskColor.color

fiftyone.core.session.events.MaskColor.html#color

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.MaskColor.intTarget

fiftyone.core.session.events.MaskColor.html#intTarget

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.CustomizeColor

fiftyone.core.session.events.CustomizeColor.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.session.events.CustomizeColor.path

fiftyone.core.session.events.CustomizeColor.html#path

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.CustomizeColor.fieldColor

fiftyone.core.session.events.CustomizeColor.html#fieldColor

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.CustomizeColor.colorByAttribute

fiftyone.core.session.events.CustomizeColor.html#colorByAttribute

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.CustomizeColor.valueColors

fiftyone.core.session.events.CustomizeColor.html#valueColors

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.CustomizeColor.maskTargetsColors

fiftyone.core.session.events.CustomizeColor.html#maskTargetsColors

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ColorscaleList

fiftyone.core.session.events.ColorscaleList.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.session.events.ColorscaleList.value

fiftyone.core.session.events.ColorscaleList.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ColorscaleList.color

fiftyone.core.session.events.ColorscaleList.html#color

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.Colorscale

fiftyone.core.session.events.Colorscale.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.session.events.Colorscale.path

fiftyone.core.session.events.Colorscale.html#path

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.Colorscale.name

fiftyone.core.session.events.Colorscale.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.Colorscale.list

fiftyone.core.session.events.Colorscale.html#list

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.Colorscale.serialize

fiftyone.core.session.events.Colorscale.html#serialize

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.events.DefaultColorscale

fiftyone.core.session.events.DefaultColorscale.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.session.events.DefaultColorscale.name

fiftyone.core.session.events.DefaultColorscale.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.DefaultColorscale.list

fiftyone.core.session.events.DefaultColorscale.html#list

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.DefaultColorscale.serialize

fiftyone.core.session.events.DefaultColorscale.html#serialize

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.events.LabelTagsColors

fiftyone.core.session.events.LabelTagsColors.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.session.events.LabelTagsColors.fieldColor

fiftyone.core.session.events.LabelTagsColors.html#fieldColor

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.LabelTagsColors.valueColors

fiftyone.core.session.events.LabelTagsColors.html#valueColors

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ColorScheme

fiftyone.core.session.events.ColorScheme.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.session.events.ColorScheme.color_pool

fiftyone.core.session.events.ColorScheme.html#color_pool

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ColorScheme.color_by

fiftyone.core.session.events.ColorScheme.html#color_by

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ColorScheme.multicolor_keypoints

fiftyone.core.session.events.ColorScheme.html#multicolor_keypoints

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ColorScheme.opacity

fiftyone.core.session.events.ColorScheme.html#opacity

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ColorScheme.show_skeletons

fiftyone.core.session.events.ColorScheme.html#show_skeletons

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ColorScheme.fields

fiftyone.core.session.events.ColorScheme.html#fields

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ColorScheme.default_mask_targets_colors

fiftyone.core.session.events.ColorScheme.html#default_mask_targets_colors

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ColorScheme.colorscales

fiftyone.core.session.events.ColorScheme.html#colorscales

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ColorScheme.default_colorscale

fiftyone.core.session.events.ColorScheme.html#default_colorscale

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ColorScheme.label_tags

fiftyone.core.session.events.ColorScheme.html#label_tags

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ColorScheme.serialize

fiftyone.core.session.events.ColorScheme.html#serialize

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.events.SetColorScheme

fiftyone.core.session.events.SetColorScheme.html

Class

Class

PUBLIC

Set color scheme event
fiftyone.core.session.events.SetColorScheme.color_scheme

fiftyone.core.session.events.SetColorScheme.html#color_scheme

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.SetColorScheme.from_odm

fiftyone.core.session.events.SetColorScheme.html#from_odm

Function

Class Method

PUBLIC

Undocumented
fiftyone.core.session.events.SetColorScheme.to_odm

fiftyone.core.session.events.SetColorScheme.html#to_odm

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.events.SetDatasetColorScheme

fiftyone.core.session.events.SetDatasetColorScheme.html

Class

Class

PUBLIC

Set dataset color scheme event
fiftyone.core.session.events.SetSample

fiftyone.core.session.events.SetSample.html

Class

Class

PUBLIC

Set sample event
fiftyone.core.session.events.SetSample.group_id

fiftyone.core.session.events.SetSample.html#group_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.SetSample.sample_id

fiftyone.core.session.events.SetSample.html#sample_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.SetSpaces

fiftyone.core.session.events.SetSpaces.html

Class

Class

PUBLIC

Set spaces event
fiftyone.core.session.events.SetSpaces.spaces

fiftyone.core.session.events.SetSpaces.html#spaces

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.SetGroupSlice

fiftyone.core.session.events.SetGroupSlice.html

Class

Class

PUBLIC

Set group slice eventt
fiftyone.core.session.events.SetGroupSlice.slice

fiftyone.core.session.events.SetGroupSlice.html#slice

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.SetFieldVisibilityStage

fiftyone.core.session.events.SetFieldVisibilityStage.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.session.events.SetFieldVisibilityStage.stage

fiftyone.core.session.events.SetFieldVisibilityStage.html#stage

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.StateUpdate

fiftyone.core.session.events.StateUpdate.html

Class

Class

PUBLIC

State update event
fiftyone.core.session.events.StateUpdate.state

fiftyone.core.session.events.StateUpdate.html#state

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.AppInitializer

fiftyone.core.session.events.AppInitializer.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.session.events.AppInitializer.dataset

fiftyone.core.session.events.AppInitializer.html#dataset

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.AppInitializer.group_id

fiftyone.core.session.events.AppInitializer.html#group_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.AppInitializer.group_slice

fiftyone.core.session.events.AppInitializer.html#group_slice

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.AppInitializer.sample_id

fiftyone.core.session.events.AppInitializer.html#sample_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.AppInitializer.view

fiftyone.core.session.events.AppInitializer.html#view

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.AppInitializer.workspace

fiftyone.core.session.events.AppInitializer.html#workspace

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ListenPayload

fiftyone.core.session.events.ListenPayload.html

Class

Class

PUBLIC

An initialization payload for an event listener request
fiftyone.core.session.events.ListenPayload.initializer

fiftyone.core.session.events.ListenPayload.html#initializer

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ListenPayload.events

fiftyone.core.session.events.ListenPayload.html#events

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ListenPayload.subscription

fiftyone.core.session.events.ListenPayload.html#subscription

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ListenPayload.polling

fiftyone.core.session.events.ListenPayload.html#polling

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.events.ListenPayload.from_dict

fiftyone.core.session.events.ListenPayload.html#from_dict

Function

Class Method

PUBLIC

Undocumented
fiftyone.core.session.events.add_screenshot

fiftyone.core.session.events.html#add_screenshot

Function

Function

PUBLIC

Undocumented
fiftyone.core.session.events.dict_factory

fiftyone.core.session.events.html#dict_factory

Function

Function

PUBLIC

Undocumented
fiftyone.core.session.events.get_screenshot

fiftyone.core.session.events.html#get_screenshot

Function

Function

PUBLIC

Undocumented
fiftyone.core.session.events._asdict

fiftyone.core.session.events.html#_asdict

Function

Function

PRIVATE

Undocumented
fiftyone.core.session.events._load_state

fiftyone.core.session.events.html#_load_state

Function

Function

PRIVATE

Undocumented
fiftyone.core.session.events._serialize_rgb_colorscale

fiftyone.core.session.events.html#_serialize_rgb_colorscale

Function

Function

PRIVATE

Undocumented
fiftyone.core.session.session.logger

fiftyone.core.session.session.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.session.session._session

fiftyone.core.session.session.html#_session

Attribute

Variable

PRIVATE

Undocumented
fiftyone.core.session.session._server_services

fiftyone.core.session.session.html#_server_services

Attribute

Variable

PRIVATE

Undocumented
fiftyone.core.session.session._subscribed_sessions

fiftyone.core.session.session.html#_subscribed_sessions

Attribute

Variable

PRIVATE

Undocumented
fiftyone.core.session.session._APP_WEB_MESSAGE

fiftyone.core.session.session.html#_APP_WEB_MESSAGE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.session.session._APP_NOTEBOOK_MESSAGE

fiftyone.core.session.session.html#_APP_NOTEBOOK_MESSAGE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.session.session._REMOTE_INSTRUCTIONS

fiftyone.core.session.session.html#_REMOTE_INSTRUCTIONS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.session.session._WAIT_INSTRUCTIONS

fiftyone.core.session.session.html#_WAIT_INSTRUCTIONS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.session.session._WELCOME_MESSAGE

fiftyone.core.session.session.html#_WELCOME_MESSAGE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.session.session.launch_app

fiftyone.core.session.session.html#launch_app

Function

Function

PUBLIC

Launches the FiftyOne App.
fiftyone.core.session.session.close_app

fiftyone.core.session.session.html#close_app

Function

Function

PUBLIC

Closes the FiftyOne App, if necessary.
fiftyone.core.session.session.update_state

fiftyone.core.session.session.html#update_state

Function

Function

PUBLIC

Session method decorator for triggering state update events
fiftyone.core.session.session.Session

fiftyone.core.session.session.Session.html

Class

Class

PUBLIC

Session that maintains a 1-1 shared state with the FiftyOne App.
fiftyone.core.session.session.Session.browser

fiftyone.core.session.session.Session.html#browser

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.session.session.Session.__init__

fiftyone.core.session.session.Session.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.session.Session._plots

fiftyone.core.session.session.Session.html#_plots

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.session.session.Session._wait_closed

fiftyone.core.session.session.Session.html#_wait_closed

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.session.session.Session._get_time

fiftyone.core.session.session.Session.html#_get_time

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.session.session.Session._disable_wait_warning

fiftyone.core.session.session.Session.html#_disable_wait_warning

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.session.session.Session._notebook_cells

fiftyone.core.session.session.Session.html#_notebook_cells

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.session.session.Session._state

fiftyone.core.session.session.Session.html#_state

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.session.session.Session._client

fiftyone.core.session.session.Session.html#_client

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.session.session.Session._validate

fiftyone.core.session.session.Session.html#_validate

Function

Method

PRIVATE

Undocumented
fiftyone.core.session.session.Session.__repr__

fiftyone.core.session.session.Session.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.session.Session.__del__

fiftyone.core.session.session.Session.html#__del__

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.session.Session.auto

fiftyone.core.session.session.Session.html#auto

Attribute

Property

PUBLIC

The auto setting for the session.
fiftyone.core.session.session.Session.auto.setter

fiftyone.core.session.session.Session.html#auto.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.session.Session.server_port

fiftyone.core.session.session.Session.html#server_port

Attribute

Property

PUBLIC

The server port for the session.
fiftyone.core.session.session.Session.server_address

fiftyone.core.session.session.Session.html#server_address

Attribute

Property

PUBLIC

The server address for the session, or None if not specified.
fiftyone.core.session.session.Session.remote

fiftyone.core.session.session.Session.html#remote

Attribute

Property

PUBLIC

Whether the session is remote.
fiftyone.core.session.session.Session.url

fiftyone.core.session.session.Session.html#url

Attribute

Property

PUBLIC

The URL of the session.
fiftyone.core.session.session.Session.config

fiftyone.core.session.session.Session.html#config

Attribute

Property

PUBLIC

The current fiftyone.core.config.AppConfig.
fiftyone.core.session.session.Session.config.setter

fiftyone.core.session.session.Session.html#config.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.session.Session.group_id

fiftyone.core.session.session.Session.html#group_id

Attribute

Property

PUBLIC

The current fiftyone.core.groups.Group ID in the modal, if any.
fiftyone.core.session.session.Session.group_id.setter

fiftyone.core.session.session.Session.html#group_id.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.session.Session.sample_id

fiftyone.core.session.session.Session.html#sample_id

Attribute

Property

PUBLIC

The current fiftyone.core.sample.Sample ID in the modal, if any.
fiftyone.core.session.session.Session.sample_id.setter

fiftyone.core.session.session.Session.html#sample_id.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.session.Session.spaces

fiftyone.core.session.session.Session.html#spaces

Attribute

Instance Variable

PUBLIC

The layout state for the session.
fiftyone.core.session.session.Session.spaces.setter

fiftyone.core.session.session.Session.html#spaces.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.session.Session.load_workspace

fiftyone.core.session.session.Session.html#load_workspace

Function

Method

PUBLIC

Loads the given saved workspace.
fiftyone.core.session.session.Session.color_scheme

fiftyone.core.session.session.Session.html#color_scheme

Attribute

Property

PUBLIC

The color scheme for the session.
fiftyone.core.session.session.Session.color_scheme.setter

fiftyone.core.session.session.Session.html#color_scheme.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.session.Session._collection

fiftyone.core.session.session.Session.html#_collection

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.session.session.Session.dataset

fiftyone.core.session.session.Session.html#dataset

Attribute

Property

PUBLIC

The fiftyone.core.dataset.Dataset connected to the session.
fiftyone.core.session.session.Session.dataset.setter

fiftyone.core.session.session.Session.html#dataset.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.session.Session.clear_dataset

fiftyone.core.session.session.Session.html#clear_dataset

Function

Method

PUBLIC

Clears the current fiftyone.core.dataset.Dataset from the session, if any.
fiftyone.core.session.session.Session._set_dataset

fiftyone.core.session.session.Session.html#_set_dataset

Function

Method

PRIVATE

Undocumented
fiftyone.core.session.session.Session.view

fiftyone.core.session.session.Session.html#view

Attribute

Property

PUBLIC

The fiftyone.core.view.DatasetView connected to the session, or None if no view is connected.
fiftyone.core.session.session.Session.view.setter

fiftyone.core.session.session.Session.html#view.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.session.Session.clear_view

fiftyone.core.session.session.Session.html#clear_view

Function

Method

PUBLIC

Clears the current fiftyone.core.view.DatasetView from the session, if any.
fiftyone.core.session.session.Session._set_view

fiftyone.core.session.session.Session.html#_set_view

Function

Method

PRIVATE

Undocumented
fiftyone.core.session.session.Session.has_plots

fiftyone.core.session.session.Session.html#has_plots

Attribute

Property

PUBLIC

Whether this session has any attached plots.
fiftyone.core.session.session.Session.plots 0

fiftyone.core.session.session.Session.html#plots%200

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.session.session.Session.plots

fiftyone.core.session.session.Session.html#plots

Attribute

Property

PUBLIC

The fiftyone.core.plots.manager.PlotManager instance that manages plots attached to this session.
fiftyone.core.session.session.Session.plots.setter

fiftyone.core.session.session.Session.html#plots.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.session.Session.refresh

fiftyone.core.session.session.Session.html#refresh

Function

Method

PUBLIC

Refreshes the current App window.
fiftyone.core.session.session.Session.selected

fiftyone.core.session.session.Session.html#selected

Attribute

Property

PUBLIC

A list of sample IDs of the currently selected samples in the App, if any.
fiftyone.core.session.session.Session.selected.setter

fiftyone.core.session.session.Session.html#selected.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.session.Session.clear_selected

fiftyone.core.session.session.Session.html#clear_selected

Function

Method

PUBLIC

Clears the currently selected samples, if any.
fiftyone.core.session.session.Session.select_samples

fiftyone.core.session.session.Session.html#select_samples

Function

Method

PUBLIC

Selects the specified samples in the current view in the App,
fiftyone.core.session.session.Session.selected_labels

fiftyone.core.session.session.Session.html#selected_labels

Attribute

Instance Variable

PUBLIC

A list of labels currently selected in the App.
fiftyone.core.session.session.Session.selected_labels.setter

fiftyone.core.session.session.Session.html#selected_labels.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.session.Session.select_labels

fiftyone.core.session.session.Session.html#select_labels

Function

Method

PUBLIC

Selects the specified labels in the current view in the App.
fiftyone.core.session.session.Session.clear_selected_labels

fiftyone.core.session.session.Session.html#clear_selected_labels

Function

Method

PUBLIC

Clears the currently selected labels, if any.
fiftyone.core.session.session.Session.tag_selected_samples

fiftyone.core.session.session.Session.html#tag_selected_samples

Function

Method

PUBLIC

Adds the tag to the currently selected samples, if necessary.
fiftyone.core.session.session.Session.untag_selected_samples

fiftyone.core.session.session.Session.html#untag_selected_samples

Function

Method

PUBLIC

Removes the tag from the currently selected samples, if necessary.
fiftyone.core.session.session.Session.tag_selected_labels

fiftyone.core.session.session.Session.html#tag_selected_labels

Function

Method

PUBLIC

Adds the tag to the currently selected labels, if necessary.
fiftyone.core.session.session.Session.untag_selected_labels

fiftyone.core.session.session.Session.html#untag_selected_labels

Function

Method

PUBLIC

Removes the tag from the currently selected labels, if necessary.
fiftyone.core.session.session.Session.selected_view

fiftyone.core.session.session.Session.html#selected_view

Attribute

Property

PUBLIC

A fiftyone.core.view.DatasetView containing the currently selected content in the App.
fiftyone.core.session.session.Session.summary

fiftyone.core.session.session.Session.html#summary

Function

Method

PUBLIC

Returns a string summary of the session.
fiftyone.core.session.session.Session.open

fiftyone.core.session.session.Session.html#open

Function

Method

PUBLIC

Opens the App, if necessary.
fiftyone.core.session.session.Session.open_tab

fiftyone.core.session.session.Session.html#open_tab

Function

Method

PUBLIC

Opens the App in a new tab of your browser.
fiftyone.core.session.session.Session.show

fiftyone.core.session.session.Session.html#show

Function

Method

PUBLIC

Opens the App in the output of the current notebook cell.
fiftyone.core.session.session.Session.no_show

fiftyone.core.session.session.Session.html#no_show

Function

Method

PUBLIC

Returns a context manager that temporarily prevents new App instances from being opened in the current notebook cell when methods are run that normally would show new App windows.
fiftyone.core.session.session.Session.wait

fiftyone.core.session.session.Session.html#wait

Function

Method

PUBLIC

Blocks execution until the App is closed by the user.
fiftyone.core.session.session.Session.close

fiftyone.core.session.session.Session.html#close

Function

Method

PUBLIC

Closes the session and terminates the App, if necessary.
fiftyone.core.session.session.Session.freeze

fiftyone.core.session.session.Session.html#freeze

Function

Method

PUBLIC

Screenshots the active App cell, replacing it with a static image.
fiftyone.core.session.session._attach_listeners

fiftyone.core.session.session.html#_attach_listeners

Function

Function

PRIVATE

Undocumented
fiftyone.core.session.session._register_session

fiftyone.core.session.session.html#_register_session

Function

Function

PRIVATE

Undocumented
fiftyone.core.session.session._unregister_session

fiftyone.core.session.session.html#_unregister_session

Function

Function

PRIVATE

Undocumented
fiftyone.core.session.session._log_welcome_message_if_allowed

fiftyone.core.session.session.html#_log_welcome_message_if_allowed

Function

Function

PRIVATE

Logs a welcome message the first time this function is called on a machine with a new FiftyOne version installed, if allowed.
fiftyone.core.session.session._on_refresh

fiftyone.core.session.session.html#_on_refresh

Function

Function

PRIVATE

Refreshes session state, including a dataset reload.
fiftyone.core.session.session._pull_group_slice

fiftyone.core.session.session.html#_pull_group_slice

Function

Function

PRIVATE

Undocumented
fiftyone.core.view.fost

fiftyone.core.view.html#fost

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.view.DatasetView

fiftyone.core.view.DatasetView.html

Class

Class

PUBLIC

A view into a fiftyone.core.dataset.Dataset.
fiftyone.core.view.DatasetView.__slots__

fiftyone.core.view.DatasetView.html#__slots__

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.view.DatasetView.__init__

fiftyone.core.view.DatasetView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.view.DatasetView.__dataset

fiftyone.core.view.DatasetView.html#__dataset

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.view.DatasetView.__stages

fiftyone.core.view.DatasetView.html#__stages

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.view.DatasetView.__media_type

fiftyone.core.view.DatasetView.html#__media_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.view.DatasetView.__group_slice

fiftyone.core.view.DatasetView.html#__group_slice

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.view.DatasetView.__name

fiftyone.core.view.DatasetView.html#__name

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.view.DatasetView.__eq__

fiftyone.core.view.DatasetView.html#__eq__

Function

Method

PUBLIC

Undocumented
fiftyone.core.view.DatasetView.__len__

fiftyone.core.view.DatasetView.html#__len__

Function

Method

PUBLIC

Undocumented
fiftyone.core.view.DatasetView.__getitem__

fiftyone.core.view.DatasetView.html#__getitem__

Function

Method

PUBLIC

Undocumented
fiftyone.core.view.DatasetView.__copy__

fiftyone.core.view.DatasetView.html#__copy__

Function

Method

PUBLIC

Undocumented
fiftyone.core.view.DatasetView._base_view

fiftyone.core.view.DatasetView.html#_base_view

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._dataset

fiftyone.core.view.DatasetView.html#_dataset

Attribute

Property

PRIVATE

The fiftyone.core.dataset.Dataset that serves the samples in this collection.
fiftyone.core.view.DatasetView._root_dataset

fiftyone.core.view.DatasetView.html#_root_dataset

Attribute

Property

PRIVATE

The root fiftyone.core.dataset.Dataset from which this collection is derived.
fiftyone.core.view.DatasetView._has_slices

fiftyone.core.view.DatasetView.html#_has_slices

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._parent_media_type

fiftyone.core.view.DatasetView.html#_parent_media_type

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._is_generated

fiftyone.core.view.DatasetView.html#_is_generated

Attribute

Property

PRIVATE

Whether this collection's contents is generated from another collection.
fiftyone.core.view.DatasetView._is_patches

fiftyone.core.view.DatasetView.html#_is_patches

Attribute

Property

PRIVATE

Whether this collection contains patches.
fiftyone.core.view.DatasetView._is_frames

fiftyone.core.view.DatasetView.html#_is_frames

Attribute

Property

PRIVATE

Whether this collection contains frames of a video dataset.
fiftyone.core.view.DatasetView._is_clips

fiftyone.core.view.DatasetView.html#_is_clips

Attribute

Property

PRIVATE

Whether this collection contains clips.
fiftyone.core.view.DatasetView._is_dynamic_groups

fiftyone.core.view.DatasetView.html#_is_dynamic_groups

Attribute

Property

PRIVATE

Whether this collection contains dynamic groups.
fiftyone.core.view.DatasetView._sample_cls

fiftyone.core.view.DatasetView.html#_sample_cls

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._frame_cls

fiftyone.core.view.DatasetView.html#_frame_cls

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._stages

fiftyone.core.view.DatasetView.html#_stages

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._all_stages

fiftyone.core.view.DatasetView.html#_all_stages

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.view.DatasetView.media_type

fiftyone.core.view.DatasetView.html#media_type

Attribute

Property

PUBLIC

The media type of the view.
fiftyone.core.view.DatasetView.group_field

fiftyone.core.view.DatasetView.html#group_field

Attribute

Property

PUBLIC

The group field of the view, or None if the view is not grouped.
fiftyone.core.view.DatasetView.group_slice

fiftyone.core.view.DatasetView.html#group_slice

Attribute

Property

PUBLIC

The current group slice of the view, or None if the view is not grouped.
fiftyone.core.view.DatasetView.group_slice.setter

fiftyone.core.view.DatasetView.html#group_slice.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.view.DatasetView.group_slices

fiftyone.core.view.DatasetView.html#group_slices

Attribute

Property

PUBLIC

The list of group slices of the view, or None if the view is not grouped.
fiftyone.core.view.DatasetView.group_media_types

fiftyone.core.view.DatasetView.html#group_media_types

Attribute

Property

PUBLIC

A dict mapping group slices to media types, or None if the view is not grouped.
fiftyone.core.view.DatasetView.default_group_slice

fiftyone.core.view.DatasetView.html#default_group_slice

Attribute

Property

PUBLIC

The default group slice of the view, or None if the view is not grouped.
fiftyone.core.view.DatasetView.name

fiftyone.core.view.DatasetView.html#name

Attribute

Property

PUBLIC

The name of the view if it is a saved view; otherwise None.
fiftyone.core.view.DatasetView.is_saved

fiftyone.core.view.DatasetView.html#is_saved

Attribute

Property

PUBLIC

Whether the view is a saved view or not.
fiftyone.core.view.DatasetView.dataset_name

fiftyone.core.view.DatasetView.html#dataset_name

Attribute

Property

PUBLIC

The name of the underlying dataset.
fiftyone.core.view.DatasetView.tags

fiftyone.core.view.DatasetView.html#tags

Attribute

Property

PUBLIC

The list of tags of the underlying dataset.
fiftyone.core.view.DatasetView.tags.setter

fiftyone.core.view.DatasetView.html#tags.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.view.DatasetView.description

fiftyone.core.view.DatasetView.html#description

Attribute

Property

PUBLIC

A description of the underlying dataset.
fiftyone.core.view.DatasetView.description.setter

fiftyone.core.view.DatasetView.html#description.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.view.DatasetView.info

fiftyone.core.view.DatasetView.html#info

Attribute

Property

PUBLIC

The info dict of the underlying dataset.
fiftyone.core.view.DatasetView.info.setter

fiftyone.core.view.DatasetView.html#info.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.view.DatasetView.app_config

fiftyone.core.view.DatasetView.html#app_config

Attribute

Property

PUBLIC

Dataset-specific settings that customize how this collection is visualized in the :ref:`FiftyOne App <fiftyone-app>`.
fiftyone.core.view.DatasetView.app_config.setter

fiftyone.core.view.DatasetView.html#app_config.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.view.DatasetView.classes

fiftyone.core.view.DatasetView.html#classes

Attribute

Property

PUBLIC

The classes of the underlying dataset.
fiftyone.core.view.DatasetView.classes.setter

fiftyone.core.view.DatasetView.html#classes.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.view.DatasetView.default_classes

fiftyone.core.view.DatasetView.html#default_classes

Attribute

Property

PUBLIC

The default classes of the underlying dataset.
fiftyone.core.view.DatasetView.default_classes.setter

fiftyone.core.view.DatasetView.html#default_classes.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.view.DatasetView.mask_targets

fiftyone.core.view.DatasetView.html#mask_targets

Attribute

Property

PUBLIC

The mask targets of the underlying dataset.
fiftyone.core.view.DatasetView.mask_targets.setter

fiftyone.core.view.DatasetView.html#mask_targets.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.view.DatasetView.default_mask_targets

fiftyone.core.view.DatasetView.html#default_mask_targets

Attribute

Property

PUBLIC

The default mask targets of the underlying dataset.
fiftyone.core.view.DatasetView.default_mask_targets.setter

fiftyone.core.view.DatasetView.html#default_mask_targets.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.view.DatasetView.skeletons

fiftyone.core.view.DatasetView.html#skeletons

Attribute

Property

PUBLIC

The keypoint skeletons of the underlying dataset.
fiftyone.core.view.DatasetView.skeletons.setter

fiftyone.core.view.DatasetView.html#skeletons.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.view.DatasetView.default_skeleton

fiftyone.core.view.DatasetView.html#default_skeleton

Attribute

Property

PUBLIC

The default keypoint skeleton of the underlying dataset.
fiftyone.core.view.DatasetView.default_skeleton.setter

fiftyone.core.view.DatasetView.html#default_skeleton.setter

Function

Method

PUBLIC

Undocumented
fiftyone.core.view.DatasetView.summary

fiftyone.core.view.DatasetView.html#summary

Function

Method

PUBLIC

Returns a string summary of the view.
fiftyone.core.view.DatasetView._make_view_stages_str

fiftyone.core.view.DatasetView.html#_make_view_stages_str

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView.view

fiftyone.core.view.DatasetView.html#view

Function

Method

PUBLIC

Returns a copy of this view.
fiftyone.core.view.DatasetView.iter_samples

fiftyone.core.view.DatasetView.html#iter_samples

Function

Method

PUBLIC

Returns an iterator over the samples in the view.
fiftyone.core.view.DatasetView._iter_samples

fiftyone.core.view.DatasetView.html#_iter_samples

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._make_sample

fiftyone.core.view.DatasetView.html#_make_sample

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._make_sample_fcn

fiftyone.core.view.DatasetView.html#_make_sample_fcn

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._make_frame

fiftyone.core.view.DatasetView.html#_make_frame

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._make_frame_fcn

fiftyone.core.view.DatasetView.html#_make_frame_fcn

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._init_make_sample

fiftyone.core.view.DatasetView.html#_init_make_sample

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._init_make_frame

fiftyone.core.view.DatasetView.html#_init_make_frame

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView.iter_groups

fiftyone.core.view.DatasetView.html#iter_groups

Function

Method

PUBLIC

Returns an iterator over the groups in the view.
fiftyone.core.view.DatasetView._iter_groups

fiftyone.core.view.DatasetView.html#_iter_groups

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView.iter_dynamic_groups

fiftyone.core.view.DatasetView.html#iter_dynamic_groups

Function

Method

PUBLIC

Returns an iterator over the dynamic groups in the view.
fiftyone.core.view.DatasetView._iter_dynamic_groups

fiftyone.core.view.DatasetView.html#_iter_dynamic_groups

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView.get_group

fiftyone.core.view.DatasetView.html#get_group

Function

Method

PUBLIC

Returns a dict containing the samples for the given group ID.
fiftyone.core.view.DatasetView.get_dynamic_group

fiftyone.core.view.DatasetView.html#get_dynamic_group

Function

Method

PUBLIC

Returns a view containing the samples from a dynamic grouped view with the given group value.
fiftyone.core.view.DatasetView.get_field_schema

fiftyone.core.view.DatasetView.html#get_field_schema

Function

Method

PUBLIC

Returns a schema dictionary describing the fields of the samples in the view.
fiftyone.core.view.DatasetView.get_frame_field_schema

fiftyone.core.view.DatasetView.html#get_frame_field_schema

Function

Method

PUBLIC

Returns a schema dictionary describing the fields of the frames of the samples in the view.
fiftyone.core.view.DatasetView.clone_sample_field

fiftyone.core.view.DatasetView.html#clone_sample_field

Function

Method

PUBLIC

Clones the given sample field of the view into a new field of the dataset.
fiftyone.core.view.DatasetView.clone_sample_fields

fiftyone.core.view.DatasetView.html#clone_sample_fields

Function

Method

PUBLIC

Clones the given sample fields of the view into new fields of the dataset.
fiftyone.core.view.DatasetView.clone_frame_field

fiftyone.core.view.DatasetView.html#clone_frame_field

Function

Method

PUBLIC

Clones the frame-level field of the view into a new field.
fiftyone.core.view.DatasetView.clone_frame_fields

fiftyone.core.view.DatasetView.html#clone_frame_fields

Function

Method

PUBLIC

Clones the frame-level fields of the view into new frame-level fields of the dataset.
fiftyone.core.view.DatasetView.clear_sample_field

fiftyone.core.view.DatasetView.html#clear_sample_field

Function

Method

PUBLIC

Clears the values of the field from all samples in the view.
fiftyone.core.view.DatasetView.clear_sample_fields

fiftyone.core.view.DatasetView.html#clear_sample_fields

Function

Method

PUBLIC

Clears the values of the fields from all samples in the view.
fiftyone.core.view.DatasetView.clear_frame_field

fiftyone.core.view.DatasetView.html#clear_frame_field

Function

Method

PUBLIC

Clears the values of the frame-level field from all samples in the view.
fiftyone.core.view.DatasetView.clear_frame_fields

fiftyone.core.view.DatasetView.html#clear_frame_fields

Function

Method

PUBLIC

Clears the values of the frame-level fields from all samples in the view.
fiftyone.core.view.DatasetView.clear

fiftyone.core.view.DatasetView.html#clear

Function

Method

PUBLIC

Deletes all samples in the view from the underlying dataset.
fiftyone.core.view.DatasetView.clear_frames

fiftyone.core.view.DatasetView.html#clear_frames

Function

Method

PUBLIC

Deletes all frame labels from the samples in the view from the underlying dataset.
fiftyone.core.view.DatasetView.keep

fiftyone.core.view.DatasetView.html#keep

Function

Method

PUBLIC

Deletes all samples that are not in the view from the underlying dataset.
fiftyone.core.view.DatasetView.keep_fields

fiftyone.core.view.DatasetView.html#keep_fields

Function

Method

PUBLIC

Deletes all fields that are excluded from the view from the underlying dataset.
fiftyone.core.view.DatasetView.keep_frames

fiftyone.core.view.DatasetView.html#keep_frames

Function

Method

PUBLIC

For each sample in the view, deletes all frames labels that are not in the view from the underlying dataset.
fiftyone.core.view.DatasetView.ensure_frames

fiftyone.core.view.DatasetView.html#ensure_frames

Function

Method

PUBLIC

Ensures that the video view contains frame instances for every frame of each sample's source video.
fiftyone.core.view.DatasetView.save

fiftyone.core.view.DatasetView.html#save

Function

Method

PUBLIC

Saves the contents of the view to the database.
fiftyone.core.view.DatasetView.clone

fiftyone.core.view.DatasetView.html#clone

Function

Method

PUBLIC

Creates a new dataset containing a copy of the contents of the view.
fiftyone.core.view.DatasetView.reload

fiftyone.core.view.DatasetView.html#reload

Function

Method

PUBLIC

Reloads the view.
fiftyone.core.view.DatasetView.to_dict

fiftyone.core.view.DatasetView.html#to_dict

Function

Method

PUBLIC

Returns a JSON dictionary representation of the view.
fiftyone.core.view.DatasetView._needs_frames

fiftyone.core.view.DatasetView.html#_needs_frames

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._outputs_dynamic_groups

fiftyone.core.view.DatasetView.html#_outputs_dynamic_groups

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._parse_dynamic_groups

fiftyone.core.view.DatasetView.html#_parse_dynamic_groups

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._dynamic_groups_pipeline

fiftyone.core.view.DatasetView.html#_dynamic_groups_pipeline

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._pipeline

fiftyone.core.view.DatasetView.html#_pipeline

Function

Method

PRIVATE

Returns the MongoDB aggregation pipeline for the collection.
fiftyone.core.view.DatasetView._aggregate

fiftyone.core.view.DatasetView.html#_aggregate

Function

Method

PRIVATE

Runs the MongoDB aggregation pipeline on the collection and returns the result.
fiftyone.core.view.DatasetView._serialize

fiftyone.core.view.DatasetView.html#_serialize

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._build

fiftyone.core.view.DatasetView.html#_build

Function

Static Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._slice

fiftyone.core.view.DatasetView.html#_slice

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._add_view_stage

fiftyone.core.view.DatasetView.html#_add_view_stage

Function

Method

PRIVATE

Returns a fiftyone.core.view.DatasetView containing the contents of the collection with the given fiftyone.core.stages.ViewStage` appended to its aggregation pipeline.
fiftyone.core.view.DatasetView._set_media_type

fiftyone.core.view.DatasetView.html#_set_media_type

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._set_name

fiftyone.core.view.DatasetView.html#_set_name

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._get_filtered_schema

fiftyone.core.view.DatasetView.html#_get_filtered_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._get_selected_excluded_fields

fiftyone.core.view.DatasetView.html#_get_selected_excluded_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._get_edited_fields

fiftyone.core.view.DatasetView.html#_get_edited_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._get_filtered_fields

fiftyone.core.view.DatasetView.html#_get_filtered_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._get_missing_fields

fiftyone.core.view.DatasetView.html#_get_missing_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.DatasetView._get_group_media_types

fiftyone.core.view.DatasetView.html#_get_group_media_types

Function

Method

PRIVATE

Undocumented
fiftyone.core.view.make_optimized_select_view

fiftyone.core.view.html#make_optimized_select_view

Function

Function

PUBLIC

Returns a view that selects the provided sample IDs that is optimized to reduce the document list as early as possible in the pipeline.
fiftyone.core.view._merge_selected_fields

fiftyone.core.view.html#_merge_selected_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.view._filter_schema

fiftyone.core.view.html#_filter_schema

Function

Function

PRIVATE

Undocumented
fiftyone.core.view._parse_selected_fields

fiftyone.core.view.html#_parse_selected_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.view._parse_excluded_fields

fiftyone.core.view.html#_parse_excluded_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.view._filter_embedded_field_schema

fiftyone.core.view.html#_filter_embedded_field_schema

Function

Function

PRIVATE

Undocumented
fiftyone.core.view._discard_nested_leafs

fiftyone.core.view.html#_discard_nested_leafs

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.base.foo

fiftyone.utils.eval.base.html#foo

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.eval.base.logger

fiftyone.utils.eval.base.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.eval.base.BaseEvaluationMethodConfig

fiftyone.utils.eval.base.BaseEvaluationMethodConfig.html

Class

Class

PUBLIC

Base class for configuring evaluation methods.
fiftyone.utils.eval.base.BaseEvaluationMethod

fiftyone.utils.eval.base.BaseEvaluationMethod.html

Class

Class

PUBLIC

Base class for evaluation methods.
fiftyone.utils.eval.base.BaseEvaluationMethod._get_custom_metrics

fiftyone.utils.eval.base.BaseEvaluationMethod.html#_get_custom_metrics

Function

Method

PRIVATE

Undocumented
fiftyone.utils.eval.base.BaseEvaluationMethod.compute_custom_metrics

fiftyone.utils.eval.base.BaseEvaluationMethod.html#compute_custom_metrics

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.base.BaseEvaluationMethod.get_custom_metric_fields

fiftyone.utils.eval.base.BaseEvaluationMethod.html#get_custom_metric_fields

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.base.BaseEvaluationMethod.rename_custom_metrics

fiftyone.utils.eval.base.BaseEvaluationMethod.html#rename_custom_metrics

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.base.BaseEvaluationMethod.cleanup_custom_metrics

fiftyone.utils.eval.base.BaseEvaluationMethod.html#cleanup_custom_metrics

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.base.BaseEvaluationResults

fiftyone.utils.eval.base.BaseEvaluationResults.html

Class

Class

PUBLIC

Base class for evaluation results.
fiftyone.utils.eval.base.BaseEvaluationResults.custom_metrics

fiftyone.utils.eval.base.BaseEvaluationResults.html#custom_metrics

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.base.BaseEvaluationResults.__init__

fiftyone.utils.eval.base.BaseEvaluationResults.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.base.BaseEvaluationResults.metrics

fiftyone.utils.eval.base.BaseEvaluationResults.html#metrics

Function

Method

PUBLIC

Returns the metrics associated with this evaluation run.
fiftyone.utils.eval.base.BaseEvaluationResults.print_metrics

fiftyone.utils.eval.base.BaseEvaluationResults.html#print_metrics

Function

Method

PUBLIC

Prints the metrics computed via metrics.
fiftyone.utils.eval.base.BaseEvaluationResults._get_custom_metrics

fiftyone.utils.eval.base.BaseEvaluationResults.html#_get_custom_metrics

Function

Method

PRIVATE

Undocumented
fiftyone.utils.eval.base.BaseEvaluationResults._print_metrics

fiftyone.utils.eval.base.BaseEvaluationResults.html#_print_metrics

Function

Method

PRIVATE

Undocumented
fiftyone.utils.eval.base.BaseClassificationResults

fiftyone.utils.eval.base.BaseClassificationResults.html

Class

Class

PUBLIC

Base class for evaluation results that expose classification metrics like P/R/F1 and confusion matrices.
fiftyone.utils.eval.base.BaseClassificationResults.confs

fiftyone.utils.eval.base.BaseClassificationResults.html#confs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.base.BaseClassificationResults.weights

fiftyone.utils.eval.base.BaseClassificationResults.html#weights

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.base.BaseClassificationResults.ytrue_ids

fiftyone.utils.eval.base.BaseClassificationResults.html#ytrue_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.base.BaseClassificationResults.ypred_ids

fiftyone.utils.eval.base.BaseClassificationResults.html#ypred_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.base.BaseClassificationResults.classes

fiftyone.utils.eval.base.BaseClassificationResults.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.base.BaseClassificationResults.missing

fiftyone.utils.eval.base.BaseClassificationResults.html#missing

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.base.BaseClassificationResults.__init__

fiftyone.utils.eval.base.BaseClassificationResults.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.base.BaseClassificationResults.ytrue

fiftyone.utils.eval.base.BaseClassificationResults.html#ytrue

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.base.BaseClassificationResults.ypred

fiftyone.utils.eval.base.BaseClassificationResults.html#ypred

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.base.BaseClassificationResults.report

fiftyone.utils.eval.base.BaseClassificationResults.html#report

Function

Method

PUBLIC

Generates a classification report for the results via sklearn:sklearn.metrics.classification_report.
fiftyone.utils.eval.base.BaseClassificationResults.print_report

fiftyone.utils.eval.base.BaseClassificationResults.html#print_report

Function

Method

PUBLIC

Prints a classification report for the results via sklearn:sklearn.metrics.classification_report.
fiftyone.utils.eval.base.BaseClassificationResults.metrics

fiftyone.utils.eval.base.BaseClassificationResults.html#metrics

Function

Method

PUBLIC

Computes classification metrics for the results, including accuracy, precision, recall, and F-beta score.
fiftyone.utils.eval.base.BaseClassificationResults.print_metrics

fiftyone.utils.eval.base.BaseClassificationResults.html#print_metrics

Function

Method

PUBLIC

Prints the metrics computed via metrics.
fiftyone.utils.eval.base.BaseClassificationResults.confusion_matrix

fiftyone.utils.eval.base.BaseClassificationResults.html#confusion_matrix

Function

Method

PUBLIC

Generates a confusion matrix for the results via sklearn:sklearn.metrics.confusion_matrix.
fiftyone.utils.eval.base.BaseClassificationResults.plot_confusion_matrix

fiftyone.utils.eval.base.BaseClassificationResults.html#plot_confusion_matrix

Function

Method

PUBLIC

Plots a confusion matrix for the evaluation results.
fiftyone.utils.eval.base.BaseClassificationResults._parse_classes

fiftyone.utils.eval.base.BaseClassificationResults.html#_parse_classes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.eval.base.BaseClassificationResults._confusion_matrix

fiftyone.utils.eval.base.BaseClassificationResults.html#_confusion_matrix

Function

Method

PRIVATE

Undocumented
fiftyone.utils.eval.base.BaseClassificationResults._from_dict

fiftyone.utils.eval.base.BaseClassificationResults.html#_from_dict

Function

Class Method

PRIVATE

Subclass implementation of from_dict.
fiftyone.utils.eval.base._parse_labels

fiftyone.utils.eval.base.html#_parse_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.base._compute_accuracy

fiftyone.utils.eval.base.html#_compute_accuracy

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.base._compute_support

fiftyone.utils.eval.base.html#_compute_support

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.base._compute_confusion_matrix

fiftyone.utils.eval.base.html#_compute_confusion_matrix

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.base._print_dict_as_table

fiftyone.utils.eval.base.html#_print_dict_as_table

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.classification.evaluate_classifications

fiftyone.utils.eval.classification.html#evaluate_classifications

Function

Function

PUBLIC

Evaluates the classification predictions in the given collection with respect to the specified ground truth labels.
fiftyone.utils.eval.classification.ClassificationEvaluationConfig

fiftyone.utils.eval.classification.ClassificationEvaluationConfig.html

Class

Class

PUBLIC

Base class for configuring ClassificationEvaluation instances.
fiftyone.utils.eval.classification.ClassificationEvaluationConfig.custom_metrics

fiftyone.utils.eval.classification.ClassificationEvaluationConfig.html#custom_metrics

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.classification.ClassificationEvaluationConfig.__init__

fiftyone.utils.eval.classification.ClassificationEvaluationConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.classification.ClassificationEvaluationConfig.pred_field

fiftyone.utils.eval.classification.ClassificationEvaluationConfig.html#pred_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.classification.ClassificationEvaluationConfig.gt_field

fiftyone.utils.eval.classification.ClassificationEvaluationConfig.html#gt_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.classification.ClassificationEvaluationConfig.type

fiftyone.utils.eval.classification.ClassificationEvaluationConfig.html#type

Attribute

Property

PUBLIC

The type of run.
fiftyone.utils.eval.classification.ClassificationEvaluation

fiftyone.utils.eval.classification.ClassificationEvaluation.html

Class

Class

PUBLIC

Base class for classification evaluation methods.
fiftyone.utils.eval.classification.ClassificationEvaluation.register_samples

fiftyone.utils.eval.classification.ClassificationEvaluation.html#register_samples

Function

Method

PUBLIC

Registers the collection on which evaluation will be performed.
fiftyone.utils.eval.classification.ClassificationEvaluation.evaluate_samples

fiftyone.utils.eval.classification.ClassificationEvaluation.html#evaluate_samples

Function

Method

PUBLIC

Evaluates the predicted classifications in the given samples with respect to the specified ground truth labels.
fiftyone.utils.eval.classification.ClassificationEvaluation.get_fields

fiftyone.utils.eval.classification.ClassificationEvaluation.html#get_fields

Function

Method

PUBLIC

Gets the fields that were involved in the given run.
fiftyone.utils.eval.classification.ClassificationEvaluation.rename

fiftyone.utils.eval.classification.ClassificationEvaluation.html#rename

Function

Method

PUBLIC

Performs any necessary operations required to rename this run's key.
fiftyone.utils.eval.classification.ClassificationEvaluation.cleanup

fiftyone.utils.eval.classification.ClassificationEvaluation.html#cleanup

Function

Method

PUBLIC

Cleans up the results of the run with the given key from the collection.
fiftyone.utils.eval.classification.ClassificationEvaluation._validate_run

fiftyone.utils.eval.classification.ClassificationEvaluation.html#_validate_run

Function

Method

PRIVATE

Subclass-specific validation when a run with the given key already exists.
fiftyone.utils.eval.classification.SimpleEvaluationConfig

fiftyone.utils.eval.classification.SimpleEvaluationConfig.html

Class

Class

PUBLIC

Simple classification evaluation config.
fiftyone.utils.eval.classification.SimpleEvaluationConfig.method

fiftyone.utils.eval.classification.SimpleEvaluationConfig.html#method

Attribute

Property

PUBLIC

The name of the method.
fiftyone.utils.eval.classification.SimpleEvaluation

fiftyone.utils.eval.classification.SimpleEvaluation.html

Class

Class

PUBLIC

Standard classification evaluation.
fiftyone.utils.eval.classification.SimpleEvaluation.register_samples

fiftyone.utils.eval.classification.SimpleEvaluation.html#register_samples

Function

Method

PUBLIC

Registers the collection on which evaluation will be performed.
fiftyone.utils.eval.classification.SimpleEvaluation.evaluate_samples

fiftyone.utils.eval.classification.SimpleEvaluation.html#evaluate_samples

Function

Method

PUBLIC

Evaluates the predicted classifications in the given samples with respect to the specified ground truth labels.
fiftyone.utils.eval.classification.TopKEvaluationConfig

fiftyone.utils.eval.classification.TopKEvaluationConfig.html

Class

Class

PUBLIC

Top-k classification evaluation config.
fiftyone.utils.eval.classification.TopKEvaluationConfig.k

fiftyone.utils.eval.classification.TopKEvaluationConfig.html#k

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.classification.TopKEvaluationConfig.__init__

fiftyone.utils.eval.classification.TopKEvaluationConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.classification.TopKEvaluationConfig.method

fiftyone.utils.eval.classification.TopKEvaluationConfig.html#method

Attribute

Property

PUBLIC

The name of the method.
fiftyone.utils.eval.classification.TopKEvaluation

fiftyone.utils.eval.classification.TopKEvaluation.html

Class

Class

PUBLIC

Top-k classification evaluation.
fiftyone.utils.eval.classification.TopKEvaluation.register_samples

fiftyone.utils.eval.classification.TopKEvaluation.html#register_samples

Function

Method

PUBLIC

Registers the collection on which evaluation will be performed.
fiftyone.utils.eval.classification.TopKEvaluation.evaluate_samples

fiftyone.utils.eval.classification.TopKEvaluation.html#evaluate_samples

Function

Method

PUBLIC

Evaluates the predicted classifications in the given samples with respect to the specified ground truth labels.
fiftyone.utils.eval.classification._evaluate_top_k

fiftyone.utils.eval.classification.html#_evaluate_top_k

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.classification.BinaryEvaluationConfig

fiftyone.utils.eval.classification.BinaryEvaluationConfig.html

Class

Class

PUBLIC

Binary evaluation config.
fiftyone.utils.eval.classification.BinaryEvaluationConfig.method

fiftyone.utils.eval.classification.BinaryEvaluationConfig.html#method

Attribute

Property

PUBLIC

The name of the method.
fiftyone.utils.eval.classification.BinaryEvaluation

fiftyone.utils.eval.classification.BinaryEvaluation.html

Class

Class

PUBLIC

Binary classification evaluation.
fiftyone.utils.eval.classification.BinaryEvaluation.register_samples

fiftyone.utils.eval.classification.BinaryEvaluation.html#register_samples

Function

Method

PUBLIC

Registers the collection on which evaluation will be performed.
fiftyone.utils.eval.classification.BinaryEvaluation.evaluate_samples

fiftyone.utils.eval.classification.BinaryEvaluation.html#evaluate_samples

Function

Method

PUBLIC

Evaluates the predicted classifications in the given samples with respect to the specified ground truth labels.
fiftyone.utils.eval.classification.ClassificationResults

fiftyone.utils.eval.classification.ClassificationResults.html

Class

Class

PUBLIC

Class that stores the results of a classification evaluation.
fiftyone.utils.eval.classification.BinaryClassificationResults

fiftyone.utils.eval.classification.BinaryClassificationResults.html

Class

Class

PUBLIC

Class that stores the results of a binary classification evaluation.
fiftyone.utils.eval.classification.BinaryClassificationResults.__init__

fiftyone.utils.eval.classification.BinaryClassificationResults.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.classification.BinaryClassificationResults._pos_label

fiftyone.utils.eval.classification.BinaryClassificationResults.html#_pos_label

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.eval.classification.BinaryClassificationResults.scores

fiftyone.utils.eval.classification.BinaryClassificationResults.html#scores

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.classification.BinaryClassificationResults.average_precision

fiftyone.utils.eval.classification.BinaryClassificationResults.html#average_precision

Function

Method

PUBLIC

Computes the average precision for the results via sklearn:sklearn.metrics.average_precision_score.
fiftyone.utils.eval.classification.BinaryClassificationResults.plot_pr_curve

fiftyone.utils.eval.classification.BinaryClassificationResults.html#plot_pr_curve

Function

Method

PUBLIC

Plots a precision-recall (PR) curve for the results.
fiftyone.utils.eval.classification.BinaryClassificationResults.plot_roc_curve

fiftyone.utils.eval.classification.BinaryClassificationResults.html#plot_roc_curve

Function

Method

PUBLIC

Plots a receiver operating characteristic (ROC) curve for the results.
fiftyone.utils.eval.classification.BinaryClassificationResults._parse_classes

fiftyone.utils.eval.classification.BinaryClassificationResults.html#_parse_classes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.eval.classification.BinaryClassificationResults._from_dict

fiftyone.utils.eval.classification.BinaryClassificationResults.html#_from_dict

Function

Class Method

PRIVATE

Subclass implementation of from_dict.
fiftyone.utils.eval.classification._parse_config

fiftyone.utils.eval.classification.html#_parse_config

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.classification._to_binary_scores

fiftyone.utils.eval.classification.html#_to_binary_scores

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.detection.logger

fiftyone.utils.eval.detection.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.eval.detection.evaluate_detections

fiftyone.utils.eval.detection.html#evaluate_detections

Function

Function

PUBLIC

Evaluates the predicted detections in the given samples with respect to the specified ground truth detections.
fiftyone.utils.eval.detection.DetectionEvaluationConfig

fiftyone.utils.eval.detection.DetectionEvaluationConfig.html

Class

Class

PUBLIC

Base class for configuring DetectionEvaluation instances.
fiftyone.utils.eval.detection.DetectionEvaluationConfig.iou

fiftyone.utils.eval.detection.DetectionEvaluationConfig.html#iou

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.detection.DetectionEvaluationConfig.classwise

fiftyone.utils.eval.detection.DetectionEvaluationConfig.html#classwise

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.detection.DetectionEvaluationConfig.custom_metrics

fiftyone.utils.eval.detection.DetectionEvaluationConfig.html#custom_metrics

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.detection.DetectionEvaluationConfig.__init__

fiftyone.utils.eval.detection.DetectionEvaluationConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.detection.DetectionEvaluationConfig.pred_field

fiftyone.utils.eval.detection.DetectionEvaluationConfig.html#pred_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.detection.DetectionEvaluationConfig.gt_field

fiftyone.utils.eval.detection.DetectionEvaluationConfig.html#gt_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.detection.DetectionEvaluationConfig.type

fiftyone.utils.eval.detection.DetectionEvaluationConfig.html#type

Attribute

Property

PUBLIC

The type of run.
fiftyone.utils.eval.detection.DetectionEvaluationConfig.requires_additional_fields

fiftyone.utils.eval.detection.DetectionEvaluationConfig.html#requires_additional_fields

Attribute

Property

PUBLIC

Whether fields besides pred_field and gt_field are required in order to perform evaluation.
fiftyone.utils.eval.detection.DetectionEvaluation

fiftyone.utils.eval.detection.DetectionEvaluation.html

Class

Class

PUBLIC

Base class for detection evaluation methods.
fiftyone.utils.eval.detection.DetectionEvaluation.__init__

fiftyone.utils.eval.detection.DetectionEvaluation.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.detection.DetectionEvaluation.gt_field

fiftyone.utils.eval.detection.DetectionEvaluation.html#gt_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.detection.DetectionEvaluation.pred_field

fiftyone.utils.eval.detection.DetectionEvaluation.html#pred_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.detection.DetectionEvaluation.register_samples

fiftyone.utils.eval.detection.DetectionEvaluation.html#register_samples

Function

Method

PUBLIC

Registers the collection on which evaluation will be performed.
fiftyone.utils.eval.detection.DetectionEvaluation.evaluate

fiftyone.utils.eval.detection.DetectionEvaluation.html#evaluate

Function

Method

PUBLIC

Evaluates the ground truth and predictions in the given document.
fiftyone.utils.eval.detection.DetectionEvaluation.generate_results

fiftyone.utils.eval.detection.DetectionEvaluation.html#generate_results

Function

Method

PUBLIC

Generates aggregate evaluation results for the samples.
fiftyone.utils.eval.detection.DetectionEvaluation.get_fields

fiftyone.utils.eval.detection.DetectionEvaluation.html#get_fields

Function

Method

PUBLIC

Gets the fields that were involved in the given run.
fiftyone.utils.eval.detection.DetectionEvaluation.rename

fiftyone.utils.eval.detection.DetectionEvaluation.html#rename

Function

Method

PUBLIC

Performs any necessary operations required to rename this run's key.
fiftyone.utils.eval.detection.DetectionEvaluation.cleanup

fiftyone.utils.eval.detection.DetectionEvaluation.html#cleanup

Function

Method

PUBLIC

Cleans up the results of the run with the given key from the collection.
fiftyone.utils.eval.detection.DetectionEvaluation._validate_run

fiftyone.utils.eval.detection.DetectionEvaluation.html#_validate_run

Function

Method

PRIVATE

Subclass-specific validation when a run with the given key already exists.
fiftyone.utils.eval.detection.DetectionResults

fiftyone.utils.eval.detection.DetectionResults.html

Class

Class

PUBLIC

Class that stores the results of a detection evaluation.
fiftyone.utils.eval.detection.DetectionResults.__init__

fiftyone.utils.eval.detection.DetectionResults.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.detection.DetectionResults.ious

fiftyone.utils.eval.detection.DetectionResults.html#ious

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.detection.DetectionResults._from_dict

fiftyone.utils.eval.detection.DetectionResults.html#_from_dict

Function

Class Method

PRIVATE

Subclass implementation of from_dict.
fiftyone.utils.eval.detection._parse_config

fiftyone.utils.eval.detection.html#_parse_config

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.detection._tally_matches

fiftyone.utils.eval.detection.html#_tally_matches

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.regression.logger

fiftyone.utils.eval.regression.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.eval.regression.evaluate_regressions

fiftyone.utils.eval.regression.html#evaluate_regressions

Function

Function

PUBLIC

Evaluates the regression predictions in the given collection with respect to the specified ground truth values.
fiftyone.utils.eval.regression.RegressionEvaluationConfig

fiftyone.utils.eval.regression.RegressionEvaluationConfig.html

Class

Class

PUBLIC

Base class for configuring RegressionEvaluation instances.
fiftyone.utils.eval.regression.RegressionEvaluationConfig.gt_field

fiftyone.utils.eval.regression.RegressionEvaluationConfig.html#gt_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.regression.RegressionEvaluationConfig.custom_metrics

fiftyone.utils.eval.regression.RegressionEvaluationConfig.html#custom_metrics

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.regression.RegressionEvaluationConfig.__init__

fiftyone.utils.eval.regression.RegressionEvaluationConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.regression.RegressionEvaluationConfig.pred_field

fiftyone.utils.eval.regression.RegressionEvaluationConfig.html#pred_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.regression.RegressionEvaluationConfig.type

fiftyone.utils.eval.regression.RegressionEvaluationConfig.html#type

Attribute

Property

PUBLIC

The type of run.
fiftyone.utils.eval.regression.RegressionEvaluation

fiftyone.utils.eval.regression.RegressionEvaluation.html

Class

Class

PUBLIC

Base class for regression evaluation methods.
fiftyone.utils.eval.regression.RegressionEvaluation.register_samples

fiftyone.utils.eval.regression.RegressionEvaluation.html#register_samples

Function

Method

PUBLIC

Registers the collection on which evaluation will be performed.
fiftyone.utils.eval.regression.RegressionEvaluation.evaluate_samples

fiftyone.utils.eval.regression.RegressionEvaluation.html#evaluate_samples

Function

Method

PUBLIC

Evaluates the regression predictions in the given samples with respect to the specified ground truth values.
fiftyone.utils.eval.regression.RegressionEvaluation.get_fields

fiftyone.utils.eval.regression.RegressionEvaluation.html#get_fields

Function

Method

PUBLIC

Gets the fields that were involved in the given run.
fiftyone.utils.eval.regression.RegressionEvaluation.rename

fiftyone.utils.eval.regression.RegressionEvaluation.html#rename

Function

Method

PUBLIC

Performs any necessary operations required to rename this run's key.
fiftyone.utils.eval.regression.RegressionEvaluation.cleanup

fiftyone.utils.eval.regression.RegressionEvaluation.html#cleanup

Function

Method

PUBLIC

Cleans up the results of the run with the given key from the collection.
fiftyone.utils.eval.regression.RegressionEvaluation._validate_run

fiftyone.utils.eval.regression.RegressionEvaluation.html#_validate_run

Function

Method

PRIVATE

Subclass-specific validation when a run with the given key already exists.
fiftyone.utils.eval.regression.SimpleEvaluationConfig

fiftyone.utils.eval.regression.SimpleEvaluationConfig.html

Class

Class

PUBLIC

Base class for configuring SimpleEvaluation instances.
fiftyone.utils.eval.regression.SimpleEvaluationConfig.__init__

fiftyone.utils.eval.regression.SimpleEvaluationConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.regression.SimpleEvaluationConfig._metric

fiftyone.utils.eval.regression.SimpleEvaluationConfig.html#_metric

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.eval.regression.SimpleEvaluationConfig.method

fiftyone.utils.eval.regression.SimpleEvaluationConfig.html#method

Attribute

Property

PUBLIC

The name of the method.
fiftyone.utils.eval.regression.SimpleEvaluationConfig.metric

fiftyone.utils.eval.regression.SimpleEvaluationConfig.html#metric

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.eval.regression.SimpleEvaluationConfig.attributes

fiftyone.utils.eval.regression.SimpleEvaluationConfig.html#attributes

Function

Method

PUBLIC

Returns the list of class attributes that will be serialized by serialize.
fiftyone.utils.eval.regression.SimpleEvaluation

fiftyone.utils.eval.regression.SimpleEvaluation.html

Class

Class

PUBLIC

Simple regression evaluation.
fiftyone.utils.eval.regression.SimpleEvaluation.evaluate_samples

fiftyone.utils.eval.regression.SimpleEvaluation.html#evaluate_samples

Function

Method

PUBLIC

Evaluates the regression predictions in the given samples with respect to the specified ground truth values.
fiftyone.utils.eval.regression.RegressionResults

fiftyone.utils.eval.regression.RegressionResults.html

Class

Class

PUBLIC

Class that stores the results of a regression evaluation.
fiftyone.utils.eval.regression.RegressionResults.confs

fiftyone.utils.eval.regression.RegressionResults.html#confs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.regression.RegressionResults.ids

fiftyone.utils.eval.regression.RegressionResults.html#ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.regression.RegressionResults.missing

fiftyone.utils.eval.regression.RegressionResults.html#missing

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.regression.RegressionResults.__init__

fiftyone.utils.eval.regression.RegressionResults.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.regression.RegressionResults.ytrue

fiftyone.utils.eval.regression.RegressionResults.html#ytrue

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.regression.RegressionResults.ypred

fiftyone.utils.eval.regression.RegressionResults.html#ypred

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.regression.RegressionResults.metrics

fiftyone.utils.eval.regression.RegressionResults.html#metrics

Function

Method

PUBLIC

Computes various popular regression metrics for the results.
fiftyone.utils.eval.regression.RegressionResults.print_metrics

fiftyone.utils.eval.regression.RegressionResults.html#print_metrics

Function

Method

PUBLIC

Prints the metrics computed via metrics.
fiftyone.utils.eval.regression.RegressionResults.plot_results

fiftyone.utils.eval.regression.RegressionResults.html#plot_results

Function

Method

PUBLIC

Plots the regression results.
fiftyone.utils.eval.regression.RegressionResults._from_dict

fiftyone.utils.eval.regression.RegressionResults.html#_from_dict

Function

Class Method

PRIVATE

Subclass implementation of from_dict.
fiftyone.utils.eval.regression._parse_config

fiftyone.utils.eval.regression.html#_parse_config

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.regression._safe_mean

fiftyone.utils.eval.regression.html#_safe_mean

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.regression._parse_values

fiftyone.utils.eval.regression.html#_parse_values

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.segmentation.logger

fiftyone.utils.eval.segmentation.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.eval.segmentation.evaluate_segmentations

fiftyone.utils.eval.segmentation.html#evaluate_segmentations

Function

Function

PUBLIC

Evaluates the specified semantic segmentation masks in the given collection with respect to the specified ground truth masks.
fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig

fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.html

Class

Class

PUBLIC

Base class for configuring SegmentationEvaluation instances.
fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.compute_dice

fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.html#compute_dice

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.custom_metrics

fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.html#custom_metrics

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.__init__

fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.pred_field

fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.html#pred_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.gt_field

fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.html#gt_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.type

fiftyone.utils.eval.segmentation.SegmentationEvaluationConfig.html#type

Attribute

Property

PUBLIC

The type of run.
fiftyone.utils.eval.segmentation.SegmentationEvaluation

fiftyone.utils.eval.segmentation.SegmentationEvaluation.html

Class

Class

PUBLIC

Base class for segmentation evaluation methods.
fiftyone.utils.eval.segmentation.SegmentationEvaluation.register_samples

fiftyone.utils.eval.segmentation.SegmentationEvaluation.html#register_samples

Function

Method

PUBLIC

Registers the collection on which evaluation will be performed.
fiftyone.utils.eval.segmentation.SegmentationEvaluation.evaluate_samples

fiftyone.utils.eval.segmentation.SegmentationEvaluation.html#evaluate_samples

Function

Method

PUBLIC

Evaluates the predicted segmentation masks in the given samples with respect to the specified ground truth masks.
fiftyone.utils.eval.segmentation.SegmentationEvaluation.get_fields

fiftyone.utils.eval.segmentation.SegmentationEvaluation.html#get_fields

Function

Method

PUBLIC

Gets the fields that were involved in the given run.
fiftyone.utils.eval.segmentation.SegmentationEvaluation.rename

fiftyone.utils.eval.segmentation.SegmentationEvaluation.html#rename

Function

Method

PUBLIC

Performs any necessary operations required to rename this run's key.
fiftyone.utils.eval.segmentation.SegmentationEvaluation.cleanup

fiftyone.utils.eval.segmentation.SegmentationEvaluation.html#cleanup

Function

Method

PUBLIC

Cleans up the results of the run with the given key from the collection.
fiftyone.utils.eval.segmentation.SegmentationEvaluation._validate_run

fiftyone.utils.eval.segmentation.SegmentationEvaluation.html#_validate_run

Function

Method

PRIVATE

Subclass-specific validation when a run with the given key already exists.
fiftyone.utils.eval.segmentation.SimpleEvaluationConfig

fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.html

Class

Class

PUBLIC

Class for configuring SimpleEvaluation instances.
fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.bandwidth

fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.html#bandwidth

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.average

fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.html#average

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.__init__

fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.method

fiftyone.utils.eval.segmentation.SimpleEvaluationConfig.html#method

Attribute

Property

PUBLIC

The name of the method.
fiftyone.utils.eval.segmentation.SimpleEvaluation

fiftyone.utils.eval.segmentation.SimpleEvaluation.html

Class

Class

PUBLIC

Standard pixelwise segmentation evaluation.
fiftyone.utils.eval.segmentation.SimpleEvaluation.evaluate_samples

fiftyone.utils.eval.segmentation.SimpleEvaluation.html#evaluate_samples

Function

Method

PUBLIC

Evaluates the predicted segmentation masks in the given samples with respect to the specified ground truth masks.
fiftyone.utils.eval.segmentation.SegmentationResults

fiftyone.utils.eval.segmentation.SegmentationResults.html

Class

Class

PUBLIC

Class that stores the results of a segmentation evaluation.
fiftyone.utils.eval.segmentation.SegmentationResults.__init__

fiftyone.utils.eval.segmentation.SegmentationResults.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.segmentation.SegmentationResults.pixel_confusion_matrix

fiftyone.utils.eval.segmentation.SegmentationResults.html#pixel_confusion_matrix

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.segmentation.SegmentationResults.dice_score

fiftyone.utils.eval.segmentation.SegmentationResults.html#dice_score

Function

Method

PUBLIC

Computes the Dice score across all samples in the evaluation.
fiftyone.utils.eval.segmentation.SegmentationResults._from_dict

fiftyone.utils.eval.segmentation.SegmentationResults.html#_from_dict

Function

Class Method

PRIVATE

Subclass implementation of from_dict.
fiftyone.utils.eval.segmentation.SegmentationResults._parse_confusion_matrix

fiftyone.utils.eval.segmentation.SegmentationResults.html#_parse_confusion_matrix

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.eval.segmentation._parse_config

fiftyone.utils.eval.segmentation.html#_parse_config

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.segmentation._compute_pixel_confusion_matrix

fiftyone.utils.eval.segmentation.html#_compute_pixel_confusion_matrix

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.segmentation._compute_dice_score

fiftyone.utils.eval.segmentation.html#_compute_dice_score

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.segmentation._extract_contour_band_values

fiftyone.utils.eval.segmentation.html#_extract_contour_band_values

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.segmentation._compute_accuracy_precision_recall

fiftyone.utils.eval.segmentation.html#_compute_accuracy_precision_recall

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.segmentation._get_mask_values

fiftyone.utils.eval.segmentation.html#_get_mask_values

Function

Function

PRIVATE

Undocumented
fiftyone.utils.quickstart.quickstart

fiftyone.utils.quickstart.html#quickstart

Function

Function

PUBLIC

Runs the FiftyOne quickstart.
fiftyone.utils.quickstart._quickstart

fiftyone.utils.quickstart.html#_quickstart

Function

Function

PRIVATE

Undocumented
fiftyone.utils.quickstart._video_quickstart

fiftyone.utils.quickstart.html#_video_quickstart

Function

Function

PRIVATE

Undocumented
fiftyone.utils.quickstart._launch_app

fiftyone.utils.quickstart.html#_launch_app

Function

Function

PRIVATE

Undocumented
fiftyone.utils.quickstart._QUICKSTART_GUIDE

fiftyone.utils.quickstart.html#_QUICKSTART_GUIDE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.quickstart._VIDEO_QUICKSTART_GUIDE

fiftyone.utils.quickstart.html#_VIDEO_QUICKSTART_GUIDE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.constants.CLIENT_TYPE

fiftyone.constants.html#CLIENT_TYPE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.FIFTYONE_DIR

fiftyone.constants.html#FIFTYONE_DIR

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.FIFTYONE_CONFIG_DIR

fiftyone.constants.html#FIFTYONE_CONFIG_DIR

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.FIFTYONE_CONFIG_PATH

fiftyone.constants.html#FIFTYONE_CONFIG_PATH

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.FIFTYONE_ANNOTATION_CONFIG_PATH

fiftyone.constants.html#FIFTYONE_ANNOTATION_CONFIG_PATH

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.FIFTYONE_EVALUATION_CONFIG_PATH

fiftyone.constants.html#FIFTYONE_EVALUATION_CONFIG_PATH

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.FIFTYONE_APP_CONFIG_PATH

fiftyone.constants.html#FIFTYONE_APP_CONFIG_PATH

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.BASE_DIR

fiftyone.constants.html#BASE_DIR

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.TEAMS_PATH

fiftyone.constants.html#TEAMS_PATH

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.WELCOME_PATH

fiftyone.constants.html#WELCOME_PATH

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.RESOURCES_DIR

fiftyone.constants.html#RESOURCES_DIR

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.COMPATIBLE_VERSIONS

fiftyone.constants.html#COMPATIBLE_VERSIONS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants._META

fiftyone.constants.html#_META

Attribute

Constant

PRIVATE

Undocumented
fiftyone.constants.NAME

fiftyone.constants.html#NAME

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.VERSION

fiftyone.constants.html#VERSION

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.DESCRIPTION

fiftyone.constants.html#DESCRIPTION

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.AUTHOR

fiftyone.constants.html#AUTHOR

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.AUTHOR_EMAIL

fiftyone.constants.html#AUTHOR_EMAIL

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.URL

fiftyone.constants.html#URL

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.LICENSE

fiftyone.constants.html#LICENSE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.VERSION_LONG

fiftyone.constants.html#VERSION_LONG

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.COPYRIGHT

fiftyone.constants.html#COPYRIGHT

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.DEV_INSTALL

fiftyone.constants.html#DEV_INSTALL

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.RC_INSTALL

fiftyone.constants.html#RC_INSTALL

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.DEFAULT_APP_COLOR_POOL

fiftyone.constants.html#DEFAULT_APP_COLOR_POOL

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.DEFAULT_COLOR_SCHEME

fiftyone.constants.html#DEFAULT_COLOR_SCHEME

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.DEFAULT_DB_DIR

fiftyone.constants.html#DEFAULT_DB_DIR

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.MIGRATIONS_PATH

fiftyone.constants.html#MIGRATIONS_PATH

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.MIGRATIONS_HEAD_PATH

fiftyone.constants.html#MIGRATIONS_HEAD_PATH

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.MIGRATIONS_REVISIONS_DIR

fiftyone.constants.html#MIGRATIONS_REVISIONS_DIR

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.MIN_MONGODB_VERSION

fiftyone.constants.html#MIN_MONGODB_VERSION

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.DATABASE_APPNAME

fiftyone.constants.html#DATABASE_APPNAME

Attribute

Constant

PUBLIC

Undocumented
fiftyone.constants.SERVER_DIR

fiftyone.constants.html#SERVER_DIR

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.annotation.AnnotationInfo

fiftyone.core.annotation.AnnotationInfo.html

Class

Class

PUBLIC

Information about an annotation run on a dataset.
fiftyone.core.annotation.AnnotationInfo.config_cls

fiftyone.core.annotation.AnnotationInfo.html#config_cls

Function

Class Method

PUBLIC

The BaseRunConfig class associated with this class.
fiftyone.core.annotation.AnnotationMethodConfig

fiftyone.core.annotation.AnnotationMethodConfig.html

Class

Class

PUBLIC

Base class for configuring AnnotationMethod instances.
fiftyone.core.annotation.AnnotationMethodConfig.type

fiftyone.core.annotation.AnnotationMethodConfig.html#type

Attribute

Property

PUBLIC

The type of run.
fiftyone.core.annotation.AnnotationMethodConfig.method

fiftyone.core.annotation.AnnotationMethodConfig.html#method

Attribute

Property

PUBLIC

The name of the method.
fiftyone.core.annotation.AnnotationMethod

fiftyone.core.annotation.AnnotationMethod.html

Class

Class

PUBLIC

Base class for annotation methods.
fiftyone.core.annotation.AnnotationMethod.run_info_cls

fiftyone.core.annotation.AnnotationMethod.html#run_info_cls

Function

Class Method

PUBLIC

The BaseRunInfo class associated with this class.
fiftyone.core.annotation.AnnotationMethod._runs_field

fiftyone.core.annotation.AnnotationMethod.html#_runs_field

Function

Class Method

PRIVATE

The fiftyone.core.odm.dataset.DatasetDocument field in which these runs are stored.
fiftyone.core.annotation.AnnotationMethod._run_str

fiftyone.core.annotation.AnnotationMethod.html#_run_str

Function

Class Method

PRIVATE

A string to use when referring to these runs in log messages.
fiftyone.core.annotation.AnnotationMethod._results_cache_field

fiftyone.core.annotation.AnnotationMethod.html#_results_cache_field

Function

Class Method

PRIVATE

The fiftyone.core.dataset.Dataset field that stores the results cache for these runs.
fiftyone.core.annotation.AnnotationMethod._patch_function

fiftyone.core.annotation.AnnotationMethod.html#_patch_function

Function

Class Method

PRIVATE

A function that can patch any ReferenceField issues with a dataset's runs.
fiftyone.core.annotation.AnnotationResults

fiftyone.core.annotation.AnnotationResults.html

Class

Class

PUBLIC

Base class for annotation run results.
fiftyone.core.brain.BrainInfo

fiftyone.core.brain.BrainInfo.html

Class

Class

PUBLIC

Information about an brain method that has been run on a dataset.
fiftyone.core.brain.BrainInfo.config_cls

fiftyone.core.brain.BrainInfo.html#config_cls

Function

Class Method

PUBLIC

The BaseRunConfig class associated with this class.
fiftyone.core.brain.BrainMethodConfig

fiftyone.core.brain.BrainMethodConfig.html

Class

Class

PUBLIC

Base class for configuring BrainMethod instances.
fiftyone.core.brain.BrainMethodConfig.type

fiftyone.core.brain.BrainMethodConfig.html#type

Attribute

Property

PUBLIC

The type of run.
fiftyone.core.brain.BrainMethodConfig.method

fiftyone.core.brain.BrainMethodConfig.html#method

Attribute

Property

PUBLIC

The name of the method.
fiftyone.core.brain.BrainMethod

fiftyone.core.brain.BrainMethod.html

Class

Class

PUBLIC

Base class for brain methods.
fiftyone.core.brain.BrainMethod.run_info_cls

fiftyone.core.brain.BrainMethod.html#run_info_cls

Function

Class Method

PUBLIC

The BaseRunInfo class associated with this class.
fiftyone.core.brain.BrainMethod._runs_field

fiftyone.core.brain.BrainMethod.html#_runs_field

Function

Class Method

PRIVATE

The fiftyone.core.odm.dataset.DatasetDocument field in which these runs are stored.
fiftyone.core.brain.BrainMethod._run_str

fiftyone.core.brain.BrainMethod.html#_run_str

Function

Class Method

PRIVATE

A string to use when referring to these runs in log messages.
fiftyone.core.brain.BrainMethod._results_cache_field

fiftyone.core.brain.BrainMethod.html#_results_cache_field

Function

Class Method

PRIVATE

The fiftyone.core.dataset.Dataset field that stores the results cache for these runs.
fiftyone.core.brain.BrainMethod._patch_function

fiftyone.core.brain.BrainMethod.html#_patch_function

Function

Class Method

PRIVATE

A function that can patch any ReferenceField issues with a dataset's runs.
fiftyone.core.brain.BrainResults

fiftyone.core.brain.BrainResults.html

Class

Class

PUBLIC

Base class for brain method results.
fiftyone.core.cli._TABLE_FORMAT

fiftyone.core.cli.html#_TABLE_FORMAT

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.cli._MAX_CONSTANT_VALUE_COL_WIDTH

fiftyone.core.cli.html#_MAX_CONSTANT_VALUE_COL_WIDTH

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.cli.Command

fiftyone.core.cli.Command.html

Class

Class

PUBLIC

Interface for defining commands.
fiftyone.core.cli.Command.setup

fiftyone.core.cli.Command.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.Command.execute

fiftyone.core.cli.Command.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.FiftyOneCommand

fiftyone.core.cli.FiftyOneCommand.html

Class

Class

PUBLIC

The FiftyOne command-line interface.
fiftyone.core.cli.FiftyOneCommand.setup

fiftyone.core.cli.FiftyOneCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.FiftyOneCommand.execute

fiftyone.core.cli.FiftyOneCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.QuickstartCommand

fiftyone.core.cli.QuickstartCommand.html

Class

Class

PUBLIC

Launch a FiftyOne quickstart.
fiftyone.core.cli.QuickstartCommand.setup

fiftyone.core.cli.QuickstartCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.QuickstartCommand.execute

fiftyone.core.cli.QuickstartCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.ConfigCommand

fiftyone.core.cli.ConfigCommand.html

Class

Class

PUBLIC

Tools for working with your FiftyOne config.
fiftyone.core.cli.ConfigCommand.setup

fiftyone.core.cli.ConfigCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ConfigCommand.execute

fiftyone.core.cli.ConfigCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.ConstantsCommand

fiftyone.core.cli.ConstantsCommand.html

Class

Class

PUBLIC

Print constants from fiftyone.constants.
fiftyone.core.cli.ConstantsCommand.setup

fiftyone.core.cli.ConstantsCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ConstantsCommand.execute

fiftyone.core.cli.ConstantsCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._print_constants_table

fiftyone.core.cli.html#_print_constants_table

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli._render_constant_value

fiftyone.core.cli.html#_render_constant_value

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.ConvertCommand

fiftyone.core.cli.ConvertCommand.html

Class

Class

PUBLIC

Convert datasets on disk between supported formats.
fiftyone.core.cli.ConvertCommand.setup

fiftyone.core.cli.ConvertCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ConvertCommand.execute

fiftyone.core.cli.ConvertCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetsCommand

fiftyone.core.cli.DatasetsCommand.html

Class

Class

PUBLIC

Tools for working with FiftyOne datasets.
fiftyone.core.cli.DatasetsCommand.setup

fiftyone.core.cli.DatasetsCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetsCommand.execute

fiftyone.core.cli.DatasetsCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetsListCommand

fiftyone.core.cli.DatasetsListCommand.html

Class

Class

PUBLIC

List FiftyOne datasets.
fiftyone.core.cli.DatasetsListCommand.setup

fiftyone.core.cli.DatasetsListCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetsListCommand.execute

fiftyone.core.cli.DatasetsListCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetsInfoCommand

fiftyone.core.cli.DatasetsInfoCommand.html

Class

Class

PUBLIC

Print information about FiftyOne datasets.
fiftyone.core.cli.DatasetsInfoCommand.setup

fiftyone.core.cli.DatasetsInfoCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetsInfoCommand.execute

fiftyone.core.cli.DatasetsInfoCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._print_dataset_info

fiftyone.core.cli.html#_print_dataset_info

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli._print_all_dataset_info

fiftyone.core.cli.html#_print_all_dataset_info

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli._format_cell

fiftyone.core.cli.html#_format_cell

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.DatasetsStatsCommand

fiftyone.core.cli.DatasetsStatsCommand.html

Class

Class

PUBLIC

Print stats about FiftyOne datasets on disk.
fiftyone.core.cli.DatasetsStatsCommand.setup

fiftyone.core.cli.DatasetsStatsCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetsStatsCommand.execute

fiftyone.core.cli.DatasetsStatsCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetsCreateCommand

fiftyone.core.cli.DatasetsCreateCommand.html

Class

Class

PUBLIC

Tools for creating FiftyOne datasets.
fiftyone.core.cli.DatasetsCreateCommand.setup

fiftyone.core.cli.DatasetsCreateCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetsCreateCommand.execute

fiftyone.core.cli.DatasetsCreateCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetsHeadCommand

fiftyone.core.cli.DatasetsHeadCommand.html

Class

Class

PUBLIC

Prints the first few samples in a FiftyOne dataset.
fiftyone.core.cli.DatasetsHeadCommand.setup

fiftyone.core.cli.DatasetsHeadCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetsHeadCommand.execute

fiftyone.core.cli.DatasetsHeadCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetsTailCommand

fiftyone.core.cli.DatasetsTailCommand.html

Class

Class

PUBLIC

Prints the last few samples in a FiftyOne dataset.
fiftyone.core.cli.DatasetsTailCommand.setup

fiftyone.core.cli.DatasetsTailCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetsTailCommand.execute

fiftyone.core.cli.DatasetsTailCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetsStreamCommand

fiftyone.core.cli.DatasetsStreamCommand.html

Class

Class

PUBLIC

Stream samples in a FiftyOne dataset to the terminal.
fiftyone.core.cli.DatasetsStreamCommand.setup

fiftyone.core.cli.DatasetsStreamCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetsStreamCommand.execute

fiftyone.core.cli.DatasetsStreamCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetsExportCommand

fiftyone.core.cli.DatasetsExportCommand.html

Class

Class

PUBLIC

Export FiftyOne datasets to disk in supported formats.
fiftyone.core.cli.DatasetsExportCommand.setup

fiftyone.core.cli.DatasetsExportCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetsExportCommand.execute

fiftyone.core.cli.DatasetsExportCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetsDrawCommand

fiftyone.core.cli.DatasetsDrawCommand.html

Class

Class

PUBLIC

Renders annotated versions of samples in FiftyOne datasets to disk.
fiftyone.core.cli.DatasetsDrawCommand.setup

fiftyone.core.cli.DatasetsDrawCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetsDrawCommand.execute

fiftyone.core.cli.DatasetsDrawCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetsRenameCommand

fiftyone.core.cli.DatasetsRenameCommand.html

Class

Class

PUBLIC

Rename FiftyOne datasets.
fiftyone.core.cli.DatasetsRenameCommand.setup

fiftyone.core.cli.DatasetsRenameCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetsRenameCommand.execute

fiftyone.core.cli.DatasetsRenameCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetsDeleteCommand

fiftyone.core.cli.DatasetsDeleteCommand.html

Class

Class

PUBLIC

Delete FiftyOne datasets.
fiftyone.core.cli.DatasetsDeleteCommand.setup

fiftyone.core.cli.DatasetsDeleteCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetsDeleteCommand.execute

fiftyone.core.cli.DatasetsDeleteCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.AnnotationCommand

fiftyone.core.cli.AnnotationCommand.html

Class

Class

PUBLIC

Tools for working with the FiftyOne annotation API.
fiftyone.core.cli.AnnotationCommand.setup

fiftyone.core.cli.AnnotationCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.AnnotationCommand.execute

fiftyone.core.cli.AnnotationCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.AnnotationConfigCommand

fiftyone.core.cli.AnnotationConfigCommand.html

Class

Class

PUBLIC

Tools for working with your FiftyOne annotation config.
fiftyone.core.cli.AnnotationConfigCommand.setup

fiftyone.core.cli.AnnotationConfigCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.AnnotationConfigCommand.execute

fiftyone.core.cli.AnnotationConfigCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.AppCommand

fiftyone.core.cli.AppCommand.html

Class

Class

PUBLIC

Tools for working with the FiftyOne App.
fiftyone.core.cli.AppCommand.setup

fiftyone.core.cli.AppCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.AppCommand.execute

fiftyone.core.cli.AppCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.AppConfigCommand

fiftyone.core.cli.AppConfigCommand.html

Class

Class

PUBLIC

Tools for working with your FiftyOne App config.
fiftyone.core.cli.AppConfigCommand.setup

fiftyone.core.cli.AppConfigCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.AppConfigCommand.execute

fiftyone.core.cli.AppConfigCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.AppLaunchCommand

fiftyone.core.cli.AppLaunchCommand.html

Class

Class

PUBLIC

Launch the FiftyOne App.
fiftyone.core.cli.AppLaunchCommand.setup

fiftyone.core.cli.AppLaunchCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.AppLaunchCommand.execute

fiftyone.core.cli.AppLaunchCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._watch_session

fiftyone.core.cli.html#_watch_session

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli._wait

fiftyone.core.cli.html#_wait

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.AppViewCommand

fiftyone.core.cli.AppViewCommand.html

Class

Class

PUBLIC

View datasets in the App without persisting them to the database.
fiftyone.core.cli.AppViewCommand.setup

fiftyone.core.cli.AppViewCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.AppViewCommand.execute

fiftyone.core.cli.AppViewCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.AppConnectCommand

fiftyone.core.cli.AppConnectCommand.html

Class

Class

PUBLIC

Connect to a remote FiftyOne App in your web browser.
fiftyone.core.cli.AppConnectCommand.setup

fiftyone.core.cli.AppConnectCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.AppConnectCommand.execute

fiftyone.core.cli.AppConnectCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.BrainCommand

fiftyone.core.cli.BrainCommand.html

Class

Class

PUBLIC

Tools for working with the FiftyOne Brain.
fiftyone.core.cli.BrainCommand.setup

fiftyone.core.cli.BrainCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.BrainCommand.execute

fiftyone.core.cli.BrainCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.BrainConfigCommand

fiftyone.core.cli.BrainConfigCommand.html

Class

Class

PUBLIC

Tools for working with your FiftyOne Brain config.
fiftyone.core.cli.BrainConfigCommand.setup

fiftyone.core.cli.BrainConfigCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.BrainConfigCommand.execute

fiftyone.core.cli.BrainConfigCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.EvaluationCommand

fiftyone.core.cli.EvaluationCommand.html

Class

Class

PUBLIC

Tools for working with the FiftyOne evaluation API.
fiftyone.core.cli.EvaluationCommand.setup

fiftyone.core.cli.EvaluationCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.EvaluationCommand.execute

fiftyone.core.cli.EvaluationCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.EvaluationConfigCommand

fiftyone.core.cli.EvaluationConfigCommand.html

Class

Class

PUBLIC

Tools for working with your FiftyOne evaluation config.
fiftyone.core.cli.EvaluationConfigCommand.setup

fiftyone.core.cli.EvaluationConfigCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.EvaluationConfigCommand.execute

fiftyone.core.cli.EvaluationConfigCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.ZooCommand

fiftyone.core.cli.ZooCommand.html

Class

Class

PUBLIC

Tools for working with the FiftyOne Zoo.
fiftyone.core.cli.ZooCommand.setup

fiftyone.core.cli.ZooCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ZooCommand.execute

fiftyone.core.cli.ZooCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetZooCommand

fiftyone.core.cli.DatasetZooCommand.html

Class

Class

PUBLIC

Tools for working with the FiftyOne Dataset Zoo.
fiftyone.core.cli.DatasetZooCommand.setup

fiftyone.core.cli.DatasetZooCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetZooCommand.execute

fiftyone.core.cli.DatasetZooCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetZooListCommand

fiftyone.core.cli.DatasetZooListCommand.html

Class

Class

PUBLIC

List datasets in the FiftyOne Dataset Zoo.
fiftyone.core.cli.DatasetZooListCommand.setup

fiftyone.core.cli.DatasetZooListCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetZooListCommand.execute

fiftyone.core.cli.DatasetZooListCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._print_zoo_dataset_list

fiftyone.core.cli.html#_print_zoo_dataset_list

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.DatasetZooFindCommand

fiftyone.core.cli.DatasetZooFindCommand.html

Class

Class

PUBLIC

Locate a downloaded zoo dataset on disk.
fiftyone.core.cli.DatasetZooFindCommand.setup

fiftyone.core.cli.DatasetZooFindCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetZooFindCommand.execute

fiftyone.core.cli.DatasetZooFindCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetZooInfoCommand

fiftyone.core.cli.DatasetZooInfoCommand.html

Class

Class

PUBLIC

Print information about datasets in the FiftyOne Dataset Zoo.
fiftyone.core.cli.DatasetZooInfoCommand.setup

fiftyone.core.cli.DatasetZooInfoCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetZooInfoCommand.execute

fiftyone.core.cli.DatasetZooInfoCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetZooDownloadCommand

fiftyone.core.cli.DatasetZooDownloadCommand.html

Class

Class

PUBLIC

Download zoo datasets.
fiftyone.core.cli.DatasetZooDownloadCommand.setup

fiftyone.core.cli.DatasetZooDownloadCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetZooDownloadCommand.execute

fiftyone.core.cli.DatasetZooDownloadCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetZooLoadCommand

fiftyone.core.cli.DatasetZooLoadCommand.html

Class

Class

PUBLIC

Load zoo datasets as persistent FiftyOne datasets.
fiftyone.core.cli.DatasetZooLoadCommand.setup

fiftyone.core.cli.DatasetZooLoadCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetZooLoadCommand.execute

fiftyone.core.cli.DatasetZooLoadCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DatasetZooDeleteCommand

fiftyone.core.cli.DatasetZooDeleteCommand.html

Class

Class

PUBLIC

Deletes the local copy of the zoo dataset on disk.
fiftyone.core.cli.DatasetZooDeleteCommand.setup

fiftyone.core.cli.DatasetZooDeleteCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DatasetZooDeleteCommand.execute

fiftyone.core.cli.DatasetZooDeleteCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.ModelZooCommand

fiftyone.core.cli.ModelZooCommand.html

Class

Class

PUBLIC

Tools for working with the FiftyOne Model Zoo.
fiftyone.core.cli.ModelZooCommand.setup

fiftyone.core.cli.ModelZooCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ModelZooCommand.execute

fiftyone.core.cli.ModelZooCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.ModelZooListCommand

fiftyone.core.cli.ModelZooListCommand.html

Class

Class

PUBLIC

List models in the FiftyOne Model Zoo.
fiftyone.core.cli.ModelZooListCommand.setup

fiftyone.core.cli.ModelZooListCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ModelZooListCommand.execute

fiftyone.core.cli.ModelZooListCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._print_zoo_models_list

fiftyone.core.cli.html#_print_zoo_models_list

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.ModelZooFindCommand

fiftyone.core.cli.ModelZooFindCommand.html

Class

Class

PUBLIC

Locate the downloaded zoo model on disk.
fiftyone.core.cli.ModelZooFindCommand.setup

fiftyone.core.cli.ModelZooFindCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ModelZooFindCommand.execute

fiftyone.core.cli.ModelZooFindCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.ModelZooInfoCommand

fiftyone.core.cli.ModelZooInfoCommand.html

Class

Class

PUBLIC

Print information about models in the FiftyOne Model Zoo.
fiftyone.core.cli.ModelZooInfoCommand.setup

fiftyone.core.cli.ModelZooInfoCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ModelZooInfoCommand.execute

fiftyone.core.cli.ModelZooInfoCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.ModelZooRequirementsCommand

fiftyone.core.cli.ModelZooRequirementsCommand.html

Class

Class

PUBLIC

Handles package requirements for zoo models.
fiftyone.core.cli.ModelZooRequirementsCommand.setup

fiftyone.core.cli.ModelZooRequirementsCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ModelZooRequirementsCommand.execute

fiftyone.core.cli.ModelZooRequirementsCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._print_model_requirements

fiftyone.core.cli.html#_print_model_requirements

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.ModelZooDownloadCommand

fiftyone.core.cli.ModelZooDownloadCommand.html

Class

Class

PUBLIC

Download zoo models.
fiftyone.core.cli.ModelZooDownloadCommand.setup

fiftyone.core.cli.ModelZooDownloadCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ModelZooDownloadCommand.execute

fiftyone.core.cli.ModelZooDownloadCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.ModelZooApplyCommand

fiftyone.core.cli.ModelZooApplyCommand.html

Class

Class

PUBLIC

Apply zoo models to datasets.
fiftyone.core.cli.ModelZooApplyCommand.setup

fiftyone.core.cli.ModelZooApplyCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ModelZooApplyCommand.execute

fiftyone.core.cli.ModelZooApplyCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.ModelZooEmbedCommand

fiftyone.core.cli.ModelZooEmbedCommand.html

Class

Class

PUBLIC

Generate embeddings for datasets with zoo models.
fiftyone.core.cli.ModelZooEmbedCommand.setup

fiftyone.core.cli.ModelZooEmbedCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ModelZooEmbedCommand.execute

fiftyone.core.cli.ModelZooEmbedCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.ModelZooDeleteCommand

fiftyone.core.cli.ModelZooDeleteCommand.html

Class

Class

PUBLIC

Deletes the local copy of the zoo model on disk.
fiftyone.core.cli.ModelZooDeleteCommand.setup

fiftyone.core.cli.ModelZooDeleteCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ModelZooDeleteCommand.execute

fiftyone.core.cli.ModelZooDeleteCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.ModelZooListSourcesCommand

fiftyone.core.cli.ModelZooListSourcesCommand.html

Class

Class

PUBLIC

Lists remote zoo model sources that are registered locally.
fiftyone.core.cli.ModelZooListSourcesCommand.setup

fiftyone.core.cli.ModelZooListSourcesCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ModelZooListSourcesCommand.execute

fiftyone.core.cli.ModelZooListSourcesCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._print_zoo_model_sources_list

fiftyone.core.cli.html#_print_zoo_model_sources_list

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.ModelZooRegisterSourceCommand

fiftyone.core.cli.ModelZooRegisterSourceCommand.html

Class

Class

PUBLIC

Registers a remote source of zoo models.
fiftyone.core.cli.ModelZooRegisterSourceCommand.setup

fiftyone.core.cli.ModelZooRegisterSourceCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ModelZooRegisterSourceCommand.execute

fiftyone.core.cli.ModelZooRegisterSourceCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.ModelZooDeleteSourceCommand

fiftyone.core.cli.ModelZooDeleteSourceCommand.html

Class

Class

PUBLIC

Deletes the remote source and all downloaded models associated with it.
fiftyone.core.cli.ModelZooDeleteSourceCommand.setup

fiftyone.core.cli.ModelZooDeleteSourceCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ModelZooDeleteSourceCommand.execute

fiftyone.core.cli.ModelZooDeleteSourceCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.OperatorsCommand

fiftyone.core.cli.OperatorsCommand.html

Class

Class

PUBLIC

Tools for working with FiftyOne operators and panels.
fiftyone.core.cli.OperatorsCommand.setup

fiftyone.core.cli.OperatorsCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.OperatorsCommand.execute

fiftyone.core.cli.OperatorsCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.OperatorsListCommand

fiftyone.core.cli.OperatorsListCommand.html

Class

Class

PUBLIC

List operators and panels that are installed locally.
fiftyone.core.cli.OperatorsListCommand.setup

fiftyone.core.cli.OperatorsListCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.OperatorsListCommand.execute

fiftyone.core.cli.OperatorsListCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._print_operators_list

fiftyone.core.cli.html#_print_operators_list

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.OperatorsInfoCommand

fiftyone.core.cli.OperatorsInfoCommand.html

Class

Class

PUBLIC

Prints info about operators and panels that are installed locally.
fiftyone.core.cli.OperatorsInfoCommand.setup

fiftyone.core.cli.OperatorsInfoCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.OperatorsInfoCommand.execute

fiftyone.core.cli.OperatorsInfoCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._print_operator_info

fiftyone.core.cli.html#_print_operator_info

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.DelegatedCommand

fiftyone.core.cli.DelegatedCommand.html

Class

Class

PUBLIC

Tools for working with FiftyOne delegated operations.
fiftyone.core.cli.DelegatedCommand.setup

fiftyone.core.cli.DelegatedCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DelegatedCommand.execute

fiftyone.core.cli.DelegatedCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DelegatedLaunchCommand

fiftyone.core.cli.DelegatedLaunchCommand.html

Class

Class

PUBLIC

Launches a service for running delegated operations.
fiftyone.core.cli.DelegatedLaunchCommand.setup

fiftyone.core.cli.DelegatedLaunchCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DelegatedLaunchCommand.execute

fiftyone.core.cli.DelegatedLaunchCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._launch_delegated_local

fiftyone.core.cli.html#_launch_delegated_local

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.DelegatedListCommand

fiftyone.core.cli.DelegatedListCommand.html

Class

Class

PUBLIC

List delegated operations.
fiftyone.core.cli.DelegatedListCommand.setup

fiftyone.core.cli.DelegatedListCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DelegatedListCommand.execute

fiftyone.core.cli.DelegatedListCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._parse_state

fiftyone.core.cli.html#_parse_state

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli._parse_paging

fiftyone.core.cli.html#_parse_paging

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli._parse_sort_by

fiftyone.core.cli.html#_parse_sort_by

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli._parse_reverse

fiftyone.core.cli.html#_parse_reverse

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli._print_delegated_list

fiftyone.core.cli.html#_print_delegated_list

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.DelegatedInfoCommand

fiftyone.core.cli.DelegatedInfoCommand.html

Class

Class

PUBLIC

Prints information about a delegated operation.
fiftyone.core.cli.DelegatedInfoCommand.setup

fiftyone.core.cli.DelegatedInfoCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DelegatedInfoCommand.execute

fiftyone.core.cli.DelegatedInfoCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DelegatedFailCommand

fiftyone.core.cli.DelegatedFailCommand.html

Class

Class

PUBLIC

Manually mark delegated operations as failed.
fiftyone.core.cli.DelegatedFailCommand.setup

fiftyone.core.cli.DelegatedFailCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DelegatedFailCommand.execute

fiftyone.core.cli.DelegatedFailCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DelegatedDeleteCommand

fiftyone.core.cli.DelegatedDeleteCommand.html

Class

Class

PUBLIC

Delete delegated operations.
fiftyone.core.cli.DelegatedDeleteCommand.setup

fiftyone.core.cli.DelegatedDeleteCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DelegatedDeleteCommand.execute

fiftyone.core.cli.DelegatedDeleteCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.DelegatedCleanupCommand

fiftyone.core.cli.DelegatedCleanupCommand.html

Class

Class

PUBLIC

Cleanup delegated operations.
fiftyone.core.cli.DelegatedCleanupCommand.setup

fiftyone.core.cli.DelegatedCleanupCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.DelegatedCleanupCommand.execute

fiftyone.core.cli.DelegatedCleanupCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._cleanup_orphan_delegated

fiftyone.core.cli.html#_cleanup_orphan_delegated

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli._cleanup_delegated

fiftyone.core.cli.html#_cleanup_delegated

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.PluginsCommand

fiftyone.core.cli.PluginsCommand.html

Class

Class

PUBLIC

Tools for working with FiftyOne plugins.
fiftyone.core.cli.PluginsCommand.setup

fiftyone.core.cli.PluginsCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.PluginsCommand.execute

fiftyone.core.cli.PluginsCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.PluginsListCommand

fiftyone.core.cli.PluginsListCommand.html

Class

Class

PUBLIC

List plugins that are installed locally.
fiftyone.core.cli.PluginsListCommand.setup

fiftyone.core.cli.PluginsListCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.PluginsListCommand.execute

fiftyone.core.cli.PluginsListCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._print_plugins_list

fiftyone.core.cli.html#_print_plugins_list

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.PluginsInfoCommand

fiftyone.core.cli.PluginsInfoCommand.html

Class

Class

PUBLIC

Prints info about plugins that are installed locally.
fiftyone.core.cli.PluginsInfoCommand.setup

fiftyone.core.cli.PluginsInfoCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.PluginsInfoCommand.execute

fiftyone.core.cli.PluginsInfoCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._print_plugin_info

fiftyone.core.cli.html#_print_plugin_info

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.PluginsDownloadCommand

fiftyone.core.cli.PluginsDownloadCommand.html

Class

Class

PUBLIC

Download plugins from the web.
fiftyone.core.cli.PluginsDownloadCommand.setup

fiftyone.core.cli.PluginsDownloadCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.PluginsDownloadCommand.execute

fiftyone.core.cli.PluginsDownloadCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.PluginsRequirementsCommand

fiftyone.core.cli.PluginsRequirementsCommand.html

Class

Class

PUBLIC

Handles package requirements for plugins.
fiftyone.core.cli.PluginsRequirementsCommand.setup

fiftyone.core.cli.PluginsRequirementsCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.PluginsRequirementsCommand.execute

fiftyone.core.cli.PluginsRequirementsCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._print_plugin_requirements

fiftyone.core.cli.html#_print_plugin_requirements

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.PluginsCreateCommand

fiftyone.core.cli.PluginsCreateCommand.html

Class

Class

PUBLIC

Creates or initializes a plugin.
fiftyone.core.cli.PluginsCreateCommand.setup

fiftyone.core.cli.PluginsCreateCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.PluginsCreateCommand.execute

fiftyone.core.cli.PluginsCreateCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.PluginsEnableCommand

fiftyone.core.cli.PluginsEnableCommand.html

Class

Class

PUBLIC

Enables the given plugin(s).
fiftyone.core.cli.PluginsEnableCommand.setup

fiftyone.core.cli.PluginsEnableCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.PluginsEnableCommand.execute

fiftyone.core.cli.PluginsEnableCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.PluginsDisableCommand

fiftyone.core.cli.PluginsDisableCommand.html

Class

Class

PUBLIC

Disables the given plugin(s).
fiftyone.core.cli.PluginsDisableCommand.setup

fiftyone.core.cli.PluginsDisableCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.PluginsDisableCommand.execute

fiftyone.core.cli.PluginsDisableCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.PluginsDeleteCommand

fiftyone.core.cli.PluginsDeleteCommand.html

Class

Class

PUBLIC

Delete plugins from your local machine.
fiftyone.core.cli.PluginsDeleteCommand.setup

fiftyone.core.cli.PluginsDeleteCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.PluginsDeleteCommand.execute

fiftyone.core.cli.PluginsDeleteCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.MigrateCommand

fiftyone.core.cli.MigrateCommand.html

Class

Class

PUBLIC

Tools for migrating the FiftyOne database.
fiftyone.core.cli.MigrateCommand.setup

fiftyone.core.cli.MigrateCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.MigrateCommand.execute

fiftyone.core.cli.MigrateCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._print_migration_table

fiftyone.core.cli.html#_print_migration_table

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.UtilsCommand

fiftyone.core.cli.UtilsCommand.html

Class

Class

PUBLIC

FiftyOne utilities.
fiftyone.core.cli.UtilsCommand.setup

fiftyone.core.cli.UtilsCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.UtilsCommand.execute

fiftyone.core.cli.UtilsCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.ComputeMetadataCommand

fiftyone.core.cli.ComputeMetadataCommand.html

Class

Class

PUBLIC

Populates the metadata field of all samples in the dataset.
fiftyone.core.cli.ComputeMetadataCommand.setup

fiftyone.core.cli.ComputeMetadataCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.ComputeMetadataCommand.execute

fiftyone.core.cli.ComputeMetadataCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.TransformImagesCommand

fiftyone.core.cli.TransformImagesCommand.html

Class

Class

PUBLIC

Transforms the images in a dataset per the specified parameters.
fiftyone.core.cli.TransformImagesCommand.setup

fiftyone.core.cli.TransformImagesCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.TransformImagesCommand.execute

fiftyone.core.cli.TransformImagesCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli.TransformVideosCommand

fiftyone.core.cli.TransformVideosCommand.html

Class

Class

PUBLIC

Transforms the videos in a dataset per the specified parameters.
fiftyone.core.cli.TransformVideosCommand.setup

fiftyone.core.cli.TransformVideosCommand.html#setup

Function

Static Method

PUBLIC

Setup the command-line arguments for the command.
fiftyone.core.cli.TransformVideosCommand.execute

fiftyone.core.cli.TransformVideosCommand.html#execute

Function

Static Method

PUBLIC

Executes the command on the given args.
fiftyone.core.cli._print_dict_as_json

fiftyone.core.cli.html#_print_dict_as_json

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli._print_dict_as_table

fiftyone.core.cli.html#_print_dict_as_table

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli._has_subparsers

fiftyone.core.cli.html#_has_subparsers

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli._iter_subparsers

fiftyone.core.cli.html#_iter_subparsers

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli._RecursiveHelpAction

fiftyone.core.cli._RecursiveHelpAction.html

Class

Class

PRIVATE

Undocumented
fiftyone.core.cli._RecursiveHelpAction.__call__

fiftyone.core.cli._RecursiveHelpAction.html#__call__

Function

Method

PUBLIC

Undocumented
fiftyone.core.cli._RecursiveHelpAction._recurse

fiftyone.core.cli._RecursiveHelpAction.html#_recurse

Function

Static Method

PRIVATE

Undocumented
fiftyone.core.cli._ParseKwargsAction

fiftyone.core.cli._ParseKwargsAction.html

Class

Class

PRIVATE

Undocumented
fiftyone.core.cli._ParseKwargsAction.__call__

fiftyone.core.cli._ParseKwargsAction.html#__call__

Function

Method

PUBLIC

Undocumented
fiftyone.core.cli._parse_kwargs_value

fiftyone.core.cli.html#_parse_kwargs_value

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli._StoreSizeTupleAction

fiftyone.core.cli._StoreSizeTupleAction.html

Class

Class

PRIVATE

Undocumented
fiftyone.core.cli._StoreSizeTupleAction.__call__

fiftyone.core.cli._StoreSizeTupleAction.html#__call__

Function

Method

PUBLIC

Undocumented
fiftyone.core.cli._register_main_command

fiftyone.core.cli.html#_register_main_command

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli._register_command

fiftyone.core.cli.html#_register_command

Function

Function

PRIVATE

Undocumented
fiftyone.core.cli.main

fiftyone.core.cli.html#main

Function

Function

PUBLIC

Executes the fiftyone tool with the given command-line args.
fiftyone.core.clips.ClipView

fiftyone.core.clips.ClipView.html

Class

Class

PUBLIC

A clip in a ClipsView.
fiftyone.core.clips.ClipView._sample_id

fiftyone.core.clips.ClipView.html#_sample_id

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.clips.ClipView._save

fiftyone.core.clips.ClipView.html#_save

Function

Method

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView

fiftyone.core.clips.ClipsView.html

Class

Class

PUBLIC

A fiftyone.core.view.DatasetView of clips from a video fiftyone.core.dataset.Dataset.
fiftyone.core.clips.ClipsView.__slots__

fiftyone.core.clips.ClipsView.html#__slots__

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.clips.ClipsView.__init__

fiftyone.core.clips.ClipsView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.clips.ClipsView._classification_field

fiftyone.core.clips.ClipsView.html#_classification_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView._source_collection

fiftyone.core.clips.ClipsView.html#_source_collection

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView._clips_stage

fiftyone.core.clips.ClipsView.html#_clips_stage

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView._clips_dataset

fiftyone.core.clips.ClipsView.html#_clips_dataset

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView.__stages

fiftyone.core.clips.ClipsView.html#__stages

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView.__media_type

fiftyone.core.clips.ClipsView.html#__media_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView.__name

fiftyone.core.clips.ClipsView.html#__name

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView.__copy__

fiftyone.core.clips.ClipsView.html#__copy__

Function

Method

PUBLIC

Undocumented
fiftyone.core.clips.ClipsView._get_temporal_detection_field

fiftyone.core.clips.ClipsView.html#_get_temporal_detection_field

Function

Static Method

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView._base_view

fiftyone.core.clips.ClipsView.html#_base_view

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView._dataset

fiftyone.core.clips.ClipsView.html#_dataset

Attribute

Property

PRIVATE

The fiftyone.core.dataset.Dataset that serves the samples in this collection.
fiftyone.core.clips.ClipsView._root_dataset

fiftyone.core.clips.ClipsView.html#_root_dataset

Attribute

Property

PRIVATE

The root fiftyone.core.dataset.Dataset from which this collection is derived.
fiftyone.core.clips.ClipsView._sample_cls

fiftyone.core.clips.ClipsView.html#_sample_cls

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView._stages

fiftyone.core.clips.ClipsView.html#_stages

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView._all_stages

fiftyone.core.clips.ClipsView.html#_all_stages

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView.name

fiftyone.core.clips.ClipsView.html#name

Attribute

Property

PUBLIC

The name of the view if it is a saved view; otherwise None.
fiftyone.core.clips.ClipsView.is_saved

fiftyone.core.clips.ClipsView.html#is_saved

Attribute

Property

PUBLIC

Whether the view is a saved view or not.
fiftyone.core.clips.ClipsView.media_type

fiftyone.core.clips.ClipsView.html#media_type

Attribute

Property

PUBLIC

The media type of the view.
fiftyone.core.clips.ClipsView._set_name

fiftyone.core.clips.ClipsView.html#_set_name

Function

Method

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView._set_media_type

fiftyone.core.clips.ClipsView.html#_set_media_type

Function

Method

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView._tag_labels

fiftyone.core.clips.ClipsView.html#_tag_labels

Function

Method

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView._untag_labels

fiftyone.core.clips.ClipsView.html#_untag_labels

Function

Method

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView._to_source_ids

fiftyone.core.clips.ClipsView.html#_to_source_ids

Function

Method

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView.set_values

fiftyone.core.clips.ClipsView.html#set_values

Function

Method

PUBLIC

Sets the field or embedded field on each sample or frame in the collection to the given values.
fiftyone.core.clips.ClipsView.set_label_values

fiftyone.core.clips.ClipsView.html#set_label_values

Function

Method

PUBLIC

Sets the fields of the specified labels in the collection to the given values.
fiftyone.core.clips.ClipsView.save

fiftyone.core.clips.ClipsView.html#save

Function

Method

PUBLIC

Saves the clips in this view to the underlying dataset.
fiftyone.core.clips.ClipsView.keep

fiftyone.core.clips.ClipsView.html#keep

Function

Method

PUBLIC

Deletes all clips that are not in this view from the underlying dataset.
fiftyone.core.clips.ClipsView.keep_fields

fiftyone.core.clips.ClipsView.html#keep_fields

Function

Method

PUBLIC

Deletes any frame fields that have been excluded in this view from the frames of the underlying dataset.
fiftyone.core.clips.ClipsView.reload

fiftyone.core.clips.ClipsView.html#reload

Function

Method

PUBLIC

Reloads the view.
fiftyone.core.clips.ClipsView._sync_source_sample

fiftyone.core.clips.ClipsView.html#_sync_source_sample

Function

Method

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView._sync_source

fiftyone.core.clips.ClipsView.html#_sync_source

Function

Method

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView._sync_source_field_schema

fiftyone.core.clips.ClipsView.html#_sync_source_field_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.clips.ClipsView._sync_source_keep_fields

fiftyone.core.clips.ClipsView.html#_sync_source_keep_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.clips.TrajectoriesView

fiftyone.core.clips.TrajectoriesView.html

Class

Class

PUBLIC

A ClipsView of object trajectories from a video fiftyone.core.dataset.Dataset.
fiftyone.core.clips.TrajectoriesView.__slots__

fiftyone.core.clips.TrajectoriesView.html#__slots__

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.clips.TrajectoriesView.__init__

fiftyone.core.clips.TrajectoriesView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.clips.TrajectoriesView._num_trajectory_stages

fiftyone.core.clips.TrajectoriesView.html#_num_trajectory_stages

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.clips.TrajectoriesView._classification_field

fiftyone.core.clips.TrajectoriesView.html#_classification_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.clips.TrajectoriesView._source_collection

fiftyone.core.clips.TrajectoriesView.html#_source_collection

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.clips.TrajectoriesView._clips_stage

fiftyone.core.clips.TrajectoriesView.html#_clips_stage

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.clips.TrajectoriesView._clips_dataset

fiftyone.core.clips.TrajectoriesView.html#_clips_dataset

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.clips.TrajectoriesView.__stages

fiftyone.core.clips.TrajectoriesView.html#__stages

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.clips.TrajectoriesView.__media_type

fiftyone.core.clips.TrajectoriesView.html#__media_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.clips.TrajectoriesView.__name

fiftyone.core.clips.TrajectoriesView.html#__name

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.clips.TrajectoriesView.__copy__

fiftyone.core.clips.TrajectoriesView.html#__copy__

Function

Method

PUBLIC

Undocumented
fiftyone.core.clips.TrajectoriesView._stages

fiftyone.core.clips.TrajectoriesView.html#_stages

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.clips.TrajectoriesView._all_stages

fiftyone.core.clips.TrajectoriesView.html#_all_stages

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.clips.TrajectoriesView.name

fiftyone.core.clips.TrajectoriesView.html#name

Attribute

Property

PUBLIC

The name of the view if it is a saved view; otherwise None.
fiftyone.core.clips.TrajectoriesView.is_saved

fiftyone.core.clips.TrajectoriesView.html#is_saved

Attribute

Property

PUBLIC

Whether the view is a saved view or not.
fiftyone.core.clips.TrajectoriesView.media_type

fiftyone.core.clips.TrajectoriesView.html#media_type

Attribute

Property

PUBLIC

The media type of the view.
fiftyone.core.clips.TrajectoriesView._set_name

fiftyone.core.clips.TrajectoriesView.html#_set_name

Function

Method

PRIVATE

Undocumented
fiftyone.core.clips.TrajectoriesView._set_media_type

fiftyone.core.clips.TrajectoriesView.html#_set_media_type

Function

Method

PRIVATE

Undocumented
fiftyone.core.clips.TrajectoriesView._make_trajectory_stages

fiftyone.core.clips.TrajectoriesView.html#_make_trajectory_stages

Function

Static Method

PRIVATE

Undocumented
fiftyone.core.clips.make_clips_dataset

fiftyone.core.clips.html#make_clips_dataset

Function

Function

PUBLIC

Creates a dataset that contains one sample per clip defined by the given field or expression in the collection.
fiftyone.core.clips._is_frame_support_field

fiftyone.core.clips.html#_is_frame_support_field

Function

Function

PRIVATE

Undocumented
fiftyone.core.clips._get_label_field

fiftyone.core.clips.html#_get_label_field

Function

Function

PRIVATE

Undocumented
fiftyone.core.clips._make_pretty_summary

fiftyone.core.clips.html#_make_pretty_summary

Function

Function

PRIVATE

Undocumented
fiftyone.core.clips._write_support_clips

fiftyone.core.clips.html#_write_support_clips

Function

Function

PRIVATE

Undocumented
fiftyone.core.clips._write_temporal_detection_clips

fiftyone.core.clips.html#_write_temporal_detection_clips

Function

Function

PRIVATE

Undocumented
fiftyone.core.clips._write_trajectories

fiftyone.core.clips.html#_write_trajectories

Function

Function

PRIVATE

Undocumented
fiftyone.core.clips._write_expr_clips

fiftyone.core.clips.html#_write_expr_clips

Function

Function

PRIVATE

Undocumented
fiftyone.core.clips._write_manual_clips

fiftyone.core.clips.html#_write_manual_clips

Function

Function

PRIVATE

Undocumented
fiftyone.core.clips._get_trajectories

fiftyone.core.clips.html#_get_trajectories

Function

Function

PRIVATE

Undocumented
fiftyone.core.clips._Bounds

fiftyone.core.clips._Bounds.html

Class

Class

PRIVATE

Undocumented
fiftyone.core.clips._Bounds.__init__

fiftyone.core.clips._Bounds.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.clips._Bounds.min

fiftyone.core.clips._Bounds.html#min

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.clips._Bounds.max

fiftyone.core.clips._Bounds.html#max

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.clips._Bounds.add

fiftyone.core.clips._Bounds.html#add

Function

Method

PUBLIC

Undocumented
fiftyone.core.clips._to_rle

fiftyone.core.clips.html#_to_rle

Function

Function

PRIVATE

Undocumented
fiftyone.core.context._COLAB

fiftyone.core.context.html#_COLAB

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.context._DATABRICKS

fiftyone.core.context.html#_DATABRICKS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.context._IPYTHON

fiftyone.core.context.html#_IPYTHON

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.context._NONE

fiftyone.core.context.html#_NONE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.context._DATABRICKS_PROXY

fiftyone.core.context.html#_DATABRICKS_PROXY

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.context._DATABRICKS_HOST

fiftyone.core.context.html#_DATABRICKS_HOST

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.context._context

fiftyone.core.context.html#_context

Attribute

Variable

PRIVATE

Undocumented
fiftyone.core.context.init_context

fiftyone.core.context.html#init_context

Function

Function

PUBLIC

Initializes context settings.
fiftyone.core.context.is_notebook_context

fiftyone.core.context.html#is_notebook_context

Function

Function

PUBLIC

Determines whether this process is running in a notebook context, either Jupyter or Google Colab.
fiftyone.core.context.is_jupyter_context

fiftyone.core.context.html#is_jupyter_context

Function

Function

PUBLIC

Determines whether this process is running in a Jupyter notebook.
fiftyone.core.context.is_colab_context

fiftyone.core.context.html#is_colab_context

Function

Function

PUBLIC

Determines whether this process is running in Google Colab.
fiftyone.core.context.is_databricks_context

fiftyone.core.context.html#is_databricks_context

Function

Function

PUBLIC

Determines whether this process is running in Databricks.
fiftyone.core.context._get_context

fiftyone.core.context.html#_get_context

Function

Function

PRIVATE

Determine the most specific context that we're in.
fiftyone.core.context._requires_http_polling

fiftyone.core.context.html#_requires_http_polling

Function

Function

PRIVATE

Undocumented
fiftyone.core.context.get_url

fiftyone.core.context.html#get_url

Function

Function

PUBLIC

Undocumented
fiftyone.core.context._get_databricks_proxy

fiftyone.core.context.html#_get_databricks_proxy

Function

Function

PRIVATE

Undocumented
fiftyone.core.context._get_databricks_proxy_url

fiftyone.core.context.html#_get_databricks_proxy_url

Function

Function

PRIVATE

Undocumented
fiftyone.core.context._set_databricks

fiftyone.core.context.html#_set_databricks

Function

Function

PRIVATE

Undocumented
fiftyone.core.context.ContextError

fiftyone.core.context.ContextError.html

Class

Exception

PUBLIC

Exception raised when an action is taken in an unsupported context.
fiftyone.core.evaluation.EvaluationInfo

fiftyone.core.evaluation.EvaluationInfo.html

Class

Class

PUBLIC

Information about an evaluation that has been run on a dataset.
fiftyone.core.evaluation.EvaluationInfo.config_cls

fiftyone.core.evaluation.EvaluationInfo.html#config_cls

Function

Class Method

PUBLIC

The BaseRunConfig class associated with this class.
fiftyone.core.evaluation.EvaluationMethodConfig

fiftyone.core.evaluation.EvaluationMethodConfig.html

Class

Class

PUBLIC

Base class for configuring EvaluationMethod instances.
fiftyone.core.evaluation.EvaluationMethodConfig.type

fiftyone.core.evaluation.EvaluationMethodConfig.html#type

Attribute

Property

PUBLIC

The type of run.
fiftyone.core.evaluation.EvaluationMethodConfig.method

fiftyone.core.evaluation.EvaluationMethodConfig.html#method

Attribute

Property

PUBLIC

The name of the method.
fiftyone.core.evaluation.EvaluationMethod

fiftyone.core.evaluation.EvaluationMethod.html

Class

Class

PUBLIC

Base class for evaluation methods.
fiftyone.core.evaluation.EvaluationMethod.run_info_cls

fiftyone.core.evaluation.EvaluationMethod.html#run_info_cls

Function

Class Method

PUBLIC

The BaseRunInfo class associated with this class.
fiftyone.core.evaluation.EvaluationMethod._runs_field

fiftyone.core.evaluation.EvaluationMethod.html#_runs_field

Function

Class Method

PRIVATE

The fiftyone.core.odm.dataset.DatasetDocument field in which these runs are stored.
fiftyone.core.evaluation.EvaluationMethod._run_str

fiftyone.core.evaluation.EvaluationMethod.html#_run_str

Function

Class Method

PRIVATE

A string to use when referring to these runs in log messages.
fiftyone.core.evaluation.EvaluationMethod._results_cache_field

fiftyone.core.evaluation.EvaluationMethod.html#_results_cache_field

Function

Class Method

PRIVATE

The fiftyone.core.dataset.Dataset field that stores the results cache for these runs.
fiftyone.core.evaluation.EvaluationMethod._patch_function

fiftyone.core.evaluation.EvaluationMethod.html#_patch_function

Function

Class Method

PRIVATE

A function that can patch any ReferenceField issues with a dataset's runs.
fiftyone.core.evaluation.EvaluationResults

fiftyone.core.evaluation.EvaluationResults.html

Class

Class

PUBLIC

Base class for evaluation results.
fiftyone.core.frame_utils.is_frame_number

fiftyone.core.frame_utils.html#is_frame_number

Function

Function

PUBLIC

Determines whether the provided value is a frame number.
fiftyone.core.frame_utils.validate_frame_number

fiftyone.core.frame_utils.html#validate_frame_number

Function

Function

PUBLIC

Validates that the provided value is a frame number.
fiftyone.core.frame_utils.FrameError

fiftyone.core.frame_utils.FrameError.html

Class

Exception

PUBLIC

Exception raised when an invalid frame number is encountered.
fiftyone.core.media.VIDEO

fiftyone.core.media.html#VIDEO

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.media.IMAGE

fiftyone.core.media.html#IMAGE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.media.POINT_CLOUD

fiftyone.core.media.html#POINT_CLOUD

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.media.THREE_D

fiftyone.core.media.html#THREE_D

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.media.MEDIA_TYPES

fiftyone.core.media.html#MEDIA_TYPES

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.media.GROUP

fiftyone.core.media.html#GROUP

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.media.MIXED

fiftyone.core.media.html#MIXED

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.media.get_media_type

fiftyone.core.media.html#get_media_type

Function

Function

PUBLIC

Gets the media type for the given filepath.
fiftyone.core.media.MediaTypeError

fiftyone.core.media.MediaTypeError.html

Class

Exception

PUBLIC

Exception raised when a problem with media types is encountered.
fiftyone.core.media.SelectGroupSlicesError

fiftyone.core.media.SelectGroupSlicesError.html

Class

Exception

PUBLIC

Exception raised when a grouped collection is passed to a method that expects a primitive media type to be selected.
fiftyone.core.media.SelectGroupSlicesError.__init__

fiftyone.core.media.SelectGroupSlicesError.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.patches._PATCHES_TYPES

fiftyone.core.patches.html#_PATCHES_TYPES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.patches._NO_MATCH_ID

fiftyone.core.patches.html#_NO_MATCH_ID

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.patches._PatchView

fiftyone.core.patches._PatchView.html

Class

Class

PRIVATE

Undocumented
fiftyone.core.patches._PatchView._sample_id

fiftyone.core.patches._PatchView.html#_sample_id

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.patches._PatchView._frame_id

fiftyone.core.patches._PatchView.html#_frame_id

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.patches._PatchView._save

fiftyone.core.patches._PatchView.html#_save

Function

Method

PRIVATE

Undocumented
fiftyone.core.patches.PatchView

fiftyone.core.patches.PatchView.html

Class

Class

PUBLIC

A patch in a PatchesView.
fiftyone.core.patches.EvaluationPatchView

fiftyone.core.patches.EvaluationPatchView.html

Class

Class

PUBLIC

A patch in an EvaluationPatchesView.
fiftyone.core.patches._PatchesView

fiftyone.core.patches._PatchesView.html

Class

Class

PRIVATE

No class docstring; 0/10 property, 0/6 instance variable, 0/1 class variable, 4/19 methods documented
fiftyone.core.patches._PatchesView.__slots__

fiftyone.core.patches._PatchesView.html#__slots__

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.patches._PatchesView.__init__

fiftyone.core.patches._PatchesView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.patches._PatchesView._source_collection

fiftyone.core.patches._PatchesView.html#_source_collection

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView._patches_stage

fiftyone.core.patches._PatchesView.html#_patches_stage

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView._patches_dataset

fiftyone.core.patches._PatchesView.html#_patches_dataset

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView.__stages

fiftyone.core.patches._PatchesView.html#__stages

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView.__media_type

fiftyone.core.patches._PatchesView.html#__media_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView.__name

fiftyone.core.patches._PatchesView.html#__name

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView.__copy__

fiftyone.core.patches._PatchesView.html#__copy__

Function

Method

PUBLIC

Undocumented
fiftyone.core.patches._PatchesView._base_view

fiftyone.core.patches._PatchesView.html#_base_view

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView._dataset

fiftyone.core.patches._PatchesView.html#_dataset

Attribute

Property

PRIVATE

The fiftyone.core.dataset.Dataset that serves the samples in this collection.
fiftyone.core.patches._PatchesView._root_dataset

fiftyone.core.patches._PatchesView.html#_root_dataset

Attribute

Property

PRIVATE

The root fiftyone.core.dataset.Dataset from which this collection is derived.
fiftyone.core.patches._PatchesView._stages

fiftyone.core.patches._PatchesView.html#_stages

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView._all_stages

fiftyone.core.patches._PatchesView.html#_all_stages

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView._id_field

fiftyone.core.patches._PatchesView.html#_id_field

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView._label_fields

fiftyone.core.patches._PatchesView.html#_label_fields

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView.name

fiftyone.core.patches._PatchesView.html#name

Attribute

Property

PUBLIC

The name of the view if it is a saved view; otherwise None.
fiftyone.core.patches._PatchesView.is_saved

fiftyone.core.patches._PatchesView.html#is_saved

Attribute

Property

PUBLIC

Whether the view is a saved view or not.
fiftyone.core.patches._PatchesView.media_type

fiftyone.core.patches._PatchesView.html#media_type

Attribute

Property

PUBLIC

The media type of the view.
fiftyone.core.patches._PatchesView._set_name

fiftyone.core.patches._PatchesView.html#_set_name

Function

Method

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView._set_media_type

fiftyone.core.patches._PatchesView.html#_set_media_type

Function

Method

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView._tag_labels

fiftyone.core.patches._PatchesView.html#_tag_labels

Function

Method

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView._untag_labels

fiftyone.core.patches._PatchesView.html#_untag_labels

Function

Method

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView._to_source_ids

fiftyone.core.patches._PatchesView.html#_to_source_ids

Function

Method

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView.set_values

fiftyone.core.patches._PatchesView.html#set_values

Function

Method

PUBLIC

Sets the field or embedded field on each sample or frame in the collection to the given values.
fiftyone.core.patches._PatchesView.set_label_values

fiftyone.core.patches._PatchesView.html#set_label_values

Function

Method

PUBLIC

Sets the fields of the specified labels in the collection to the given values.
fiftyone.core.patches._PatchesView.save

fiftyone.core.patches._PatchesView.html#save

Function

Method

PUBLIC

Saves the patches in this view to the underlying dataset.
fiftyone.core.patches._PatchesView.keep

fiftyone.core.patches._PatchesView.html#keep

Function

Method

PUBLIC

Deletes all patches that are not in this view from the underlying dataset.
fiftyone.core.patches._PatchesView.keep_fields

fiftyone.core.patches._PatchesView.html#keep_fields

Function

Method

PUBLIC

Deletes all patch field(s) that have been excluded from this view from the underlying dataset.
fiftyone.core.patches._PatchesView.reload

fiftyone.core.patches._PatchesView.html#reload

Function

Method

PUBLIC

Reloads the view.
fiftyone.core.patches._PatchesView._sync_source_sample

fiftyone.core.patches._PatchesView.html#_sync_source_sample

Function

Method

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView._sync_source_sample_field

fiftyone.core.patches._PatchesView.html#_sync_source_sample_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView._sync_source

fiftyone.core.patches._PatchesView.html#_sync_source

Function

Method

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView._sync_source_field

fiftyone.core.patches._PatchesView.html#_sync_source_field

Function

Method

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView._sync_source_field_schema

fiftyone.core.patches._PatchesView.html#_sync_source_field_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.patches._PatchesView._sync_source_keep_fields

fiftyone.core.patches._PatchesView.html#_sync_source_keep_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.patches.PatchesView

fiftyone.core.patches.PatchesView.html

Class

Class

PUBLIC

A fiftyone.core.view.DatasetView of patches from a fiftyone.core.dataset.Dataset.
fiftyone.core.patches.PatchesView.__slots__

fiftyone.core.patches.PatchesView.html#__slots__

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.patches.PatchesView.__init__

fiftyone.core.patches.PatchesView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.patches.PatchesView._patches_field

fiftyone.core.patches.PatchesView.html#_patches_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.patches.PatchesView._sample_cls

fiftyone.core.patches.PatchesView.html#_sample_cls

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.patches.PatchesView._label_fields

fiftyone.core.patches.PatchesView.html#_label_fields

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.patches.PatchesView.patches_field

fiftyone.core.patches.PatchesView.html#patches_field

Attribute

Property

PUBLIC

The field from which the patches in this view were extracted.
fiftyone.core.patches.EvaluationPatchesView

fiftyone.core.patches.EvaluationPatchesView.html

Class

Class

PUBLIC

A fiftyone.core.view.DatasetView containing evaluation patches from a fiftyone.core.dataset.Dataset.
fiftyone.core.patches.EvaluationPatchesView.__slots__

fiftyone.core.patches.EvaluationPatchesView.html#__slots__

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.patches.EvaluationPatchesView.__init__

fiftyone.core.patches.EvaluationPatchesView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.patches.EvaluationPatchesView._gt_field

fiftyone.core.patches.EvaluationPatchesView.html#_gt_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.patches.EvaluationPatchesView._pred_field

fiftyone.core.patches.EvaluationPatchesView.html#_pred_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.patches.EvaluationPatchesView._sample_cls

fiftyone.core.patches.EvaluationPatchesView.html#_sample_cls

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.patches.EvaluationPatchesView._label_fields

fiftyone.core.patches.EvaluationPatchesView.html#_label_fields

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.patches.EvaluationPatchesView.gt_field

fiftyone.core.patches.EvaluationPatchesView.html#gt_field

Attribute

Property

PUBLIC

The ground truth field for the evaluation patches in this view.
fiftyone.core.patches.EvaluationPatchesView.pred_field

fiftyone.core.patches.EvaluationPatchesView.html#pred_field

Attribute

Property

PUBLIC

The predictions field for the evaluation patches in this view.
fiftyone.core.patches.make_patches_dataset

fiftyone.core.patches.html#make_patches_dataset

Function

Function

PUBLIC

Creates a dataset that contains one sample per object patch in the specified field of the collection.
fiftyone.core.patches._get_patches_field

fiftyone.core.patches.html#_get_patches_field

Function

Function

PRIVATE

Undocumented
fiftyone.core.patches.make_evaluation_patches_dataset

fiftyone.core.patches.html#make_evaluation_patches_dataset

Function

Function

PUBLIC

Creates a dataset based on the results of the evaluation with the given key that contains one sample for each true positive, false positive, and false negative example in the input collection, respectively.
fiftyone.core.patches._make_pretty_summary

fiftyone.core.patches.html#_make_pretty_summary

Function

Function

PRIVATE

Undocumented
fiftyone.core.patches._make_patches_view

fiftyone.core.patches.html#_make_patches_view

Function

Function

PRIVATE

Undocumented
fiftyone.core.patches._make_eval_view

fiftyone.core.patches.html#_make_eval_view

Function

Function

PRIVATE

Undocumented
fiftyone.core.patches._upgrade_labels

fiftyone.core.patches.html#_upgrade_labels

Function

Function

PRIVATE

Undocumented
fiftyone.core.patches._merge_matched_labels

fiftyone.core.patches.html#_merge_matched_labels

Function

Function

PRIVATE

Undocumented
fiftyone.core.patches._write_samples

fiftyone.core.patches.html#_write_samples

Function

Function

PRIVATE

Undocumented
fiftyone.core.patches._add_samples

fiftyone.core.patches.html#_add_samples

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.logger

fiftyone.core.plots.matplotlib.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.plots.matplotlib._DEFAULT_STYLE

fiftyone.core.plots.matplotlib.html#_DEFAULT_STYLE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib._DEFAULT_LINE_COLOR

fiftyone.core.plots.matplotlib.html#_DEFAULT_LINE_COLOR

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib._DEFAULT_CONTINUOUS_COLORSCALE

fiftyone.core.plots.matplotlib.html#_DEFAULT_CONTINUOUS_COLORSCALE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.plot_confusion_matrix

fiftyone.core.plots.matplotlib.html#plot_confusion_matrix

Function

Function

PUBLIC

Plots a confusion matrix.
fiftyone.core.plots.matplotlib.plot_regressions

fiftyone.core.plots.matplotlib.html#plot_regressions

Function

Function

PUBLIC

Plots the given regression results.
fiftyone.core.plots.matplotlib.plot_pr_curve

fiftyone.core.plots.matplotlib.html#plot_pr_curve

Function

Function

PUBLIC

Plots a precision-recall (PR) curve.
fiftyone.core.plots.matplotlib.plot_pr_curves

fiftyone.core.plots.matplotlib.html#plot_pr_curves

Function

Function

PUBLIC

Plots a set of per-class precision-recall (PR) curves.
fiftyone.core.plots.matplotlib.plot_roc_curve

fiftyone.core.plots.matplotlib.html#plot_roc_curve

Function

Function

PUBLIC

Plots a receiver operating characteristic (ROC) curve.
fiftyone.core.plots.matplotlib.lines

fiftyone.core.plots.matplotlib.html#lines

Function

Function

PUBLIC

Plots the given lines(s) data.
fiftyone.core.plots.matplotlib.scatterplot

fiftyone.core.plots.matplotlib.html#scatterplot

Function

Function

PUBLIC

Generates an interactive scatterplot of the given points.
fiftyone.core.plots.matplotlib.location_scatterplot

fiftyone.core.plots.matplotlib.html#location_scatterplot

Function

Function

PUBLIC

Generates an interactive scatterplot of the given location coordinates with a map rendered in the background of the plot.
fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot

fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot.html

Class

Class

PUBLIC

Base class for interactive matplotlib plots.
fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot.__init__

fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot._figure

fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot.html#_figure

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot._in_notebook_context

fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot.html#_in_notebook_context

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot.supports_session_updates

fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot.html#supports_session_updates

Attribute

Property

PUBLIC

Whether this plot supports automatic updates in response to session changes.
fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot.show

fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot.html#show

Function

Method

PUBLIC

Shows this plot.
fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot.save

fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot.html#save

Function

Method

PUBLIC

Saves the plot as an image.
fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot._show

fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot.html#_show

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot._freeze

fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot.html#_freeze

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot._reopen

fiftyone.core.plots.matplotlib.InteractiveMatplotlibPlot.html#_reopen

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection

fiftyone.core.plots.matplotlib.InteractiveCollection.html

Class

Class

PUBLIC

Interactive wrapper for a matplotlib collection.
fiftyone.core.plots.matplotlib.InteractiveCollection.alpha_other

fiftyone.core.plots.matplotlib.InteractiveCollection.html#alpha_other

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection.expand_selected

fiftyone.core.plots.matplotlib.InteractiveCollection.html#expand_selected

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection.click_tolerance

fiftyone.core.plots.matplotlib.InteractiveCollection.html#click_tolerance

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection.__init__

fiftyone.core.plots.matplotlib.InteractiveCollection.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection.collection

fiftyone.core.plots.matplotlib.InteractiveCollection.html#collection

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection.ax

fiftyone.core.plots.matplotlib.InteractiveCollection.html#ax

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._xy

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_xy

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._num_pts

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_num_pts

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._fc

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_fc

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._ms

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_ms

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._ids

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._ids_to_inds

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_ids_to_inds

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._inds

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_inds

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._canvas

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_canvas

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._lasso

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_lasso

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._shift

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_shift

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._title

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_title

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._user_button_defs

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_user_button_defs

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._sync_button_def

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_sync_button_def

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._disconnect_button_def

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_disconnect_button_def

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._buttons

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_buttons

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._figure_events

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_figure_events

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._keypress_events

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_keypress_events

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._selected_ids

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_selected_ids

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._register_sync_callback

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_register_sync_callback

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._register_disconnect_callback

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_register_disconnect_callback

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._init_canvas

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_init_canvas

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._reopen

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_reopen

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._connect

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_connect

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._disconnect

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_disconnect

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._draw

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_draw

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._freeze

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_freeze

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._init_hud

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_init_hud

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._reinit_hud

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_reinit_hud

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._close_hud

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_close_hud

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._update_hud

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_update_hud

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._on_enter

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_on_enter

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._on_exit

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_on_exit

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._on_keypress

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_on_keypress

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._on_keyrelease

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_on_keyrelease

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._on_select

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_on_select

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._select_ids

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_select_ids

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._select_inds

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_select_inds

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._update_plot

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_update_plot

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.InteractiveCollection._prep_collection

fiftyone.core.plots.matplotlib.InteractiveCollection.html#_prep_collection

Function

Method

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib._plot_lines

fiftyone.core.plots.matplotlib.html#_plot_lines

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib._plot_scatter

fiftyone.core.plots.matplotlib.html#_plot_scatter

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib._get_qualitative_colors

fiftyone.core.plots.matplotlib.html#_get_qualitative_colors

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib._plot_map_background

fiftyone.core.plots.matplotlib.html#_plot_map_background

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib._ensure_salem

fiftyone.core.plots.matplotlib.html#_ensure_salem

Function

Function

PRIVATE

Undocumented
fiftyone.core.plots.matplotlib.salem

fiftyone.core.plots.matplotlib.html#salem

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.service.logger

fiftyone.core.service.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.service.ServiceException

fiftyone.core.service.ServiceException.html

Class

Exception

PUBLIC

Base class for service-related exceptions.
fiftyone.core.service.ServiceListenTimeout

fiftyone.core.service.ServiceListenTimeout.html

Class

Exception

PUBLIC

Exception raised when a network-bound service fails to bind to a port.
fiftyone.core.service.ServiceListenTimeout.__init__

fiftyone.core.service.ServiceListenTimeout.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.service.ServiceListenTimeout.name

fiftyone.core.service.ServiceListenTimeout.html#name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.service.ServiceListenTimeout.port

fiftyone.core.service.ServiceListenTimeout.html#port

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.service.ServiceListenTimeout.__str__

fiftyone.core.service.ServiceListenTimeout.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.core.service.ServiceExecutableNotFound

fiftyone.core.service.ServiceExecutableNotFound.html

Class

Exception

PUBLIC

Exception raised when the service executable is not found on disk.
fiftyone.core.service.Service

fiftyone.core.service.Service.html

Class

Class

PUBLIC

Interface for FiftyOne services.
fiftyone.core.service.Service.service_name

fiftyone.core.service.Service.html#service_name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.service.Service.working_dir

fiftyone.core.service.Service.html#working_dir

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.service.Service.allow_headless

fiftyone.core.service.Service.html#allow_headless

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.service.Service.__init__

fiftyone.core.service.Service.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.service.Service._system

fiftyone.core.service.Service.html#_system

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.service.Service._disabled

fiftyone.core.service.Service.html#_disabled

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.service.Service.child

fiftyone.core.service.Service.html#child

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.service.Service.__del__

fiftyone.core.service.Service.html#__del__

Function

Method

PUBLIC

Stops the service.
fiftyone.core.service.Service.command

fiftyone.core.service.Service.html#command

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.service.Service.env

fiftyone.core.service.Service.html#env

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.service.Service._service_args

fiftyone.core.service.Service.html#_service_args

Attribute

Property

PRIVATE

Arguments passed to the service entrypoint.
fiftyone.core.service.Service.start

fiftyone.core.service.Service.html#start

Function

Method

PUBLIC

Starts the service.
fiftyone.core.service.Service.stop

fiftyone.core.service.Service.html#stop

Function

Method

PUBLIC

Stops the service.
fiftyone.core.service.Service.wait

fiftyone.core.service.Service.html#wait

Function

Method

PUBLIC

Waits for the service to exit and returns its exit code.
fiftyone.core.service.Service._wait_for_child_port

fiftyone.core.service.Service.html#_wait_for_child_port

Function

Method

PRIVATE

Waits for any child process of this service to bind to a TCP port.
fiftyone.core.service.MultiClientService

fiftyone.core.service.MultiClientService.html

Class

Class

PUBLIC

Base class for services that support multiple clients.
fiftyone.core.service.MultiClientService.attached

fiftyone.core.service.MultiClientService.html#attached

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.service.MultiClientService._service_args

fiftyone.core.service.MultiClientService.html#_service_args

Attribute

Property

PRIVATE

Arguments passed to the service entrypoint.
fiftyone.core.service.MultiClientService.start

fiftyone.core.service.MultiClientService.html#start

Function

Method

PUBLIC

Searches for a running instance of this service, or starts one if no instance is found.
fiftyone.core.service.MultiClientService.child

fiftyone.core.service.MultiClientService.html#child

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.core.service.MultiClientService.stop

fiftyone.core.service.MultiClientService.html#stop

Function

Method

PUBLIC

Disconnects from the service without actually stopping it.
fiftyone.core.service.DatabaseService

fiftyone.core.service.DatabaseService.html

Class

Class

PUBLIC

Service that controls the underlying MongoDB database.
fiftyone.core.service.DatabaseService.service_name

fiftyone.core.service.DatabaseService.html#service_name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.service.DatabaseService.allow_headless

fiftyone.core.service.DatabaseService.html#allow_headless

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.service.DatabaseService.MONGOD_EXE_NAME

fiftyone.core.service.DatabaseService.html#MONGOD_EXE_NAME

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.service.DatabaseService.command

fiftyone.core.service.DatabaseService.html#command

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.service.DatabaseService.port

fiftyone.core.service.DatabaseService.html#port

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.service.DatabaseService.find_mongod

fiftyone.core.service.DatabaseService.html#find_mongod

Function

Static Method

PUBLIC

Returns the path to the mongod executable.
fiftyone.core.service.ServerService

fiftyone.core.service.ServerService.html

Class

Class

PUBLIC

Service that controls the FiftyOne web server.
fiftyone.core.service.ServerService.service_name

fiftyone.core.service.ServerService.html#service_name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.service.ServerService.allow_headless

fiftyone.core.service.ServerService.html#allow_headless

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.service.ServerService.__init__

fiftyone.core.service.ServerService.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.service.ServerService._port

fiftyone.core.service.ServerService.html#_port

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.service.ServerService._address

fiftyone.core.service.ServerService.html#_address

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.service.ServerService._do_not_track

fiftyone.core.service.ServerService.html#_do_not_track

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.service.ServerService.start

fiftyone.core.service.ServerService.html#start

Function

Method

PUBLIC

Starts the service.
fiftyone.core.service.ServerService.command

fiftyone.core.service.ServerService.html#command

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.service.ServerService.port

fiftyone.core.service.ServerService.html#port

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.service.ServerService.address

fiftyone.core.service.ServerService.html#address

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.service.ServerService.env

fiftyone.core.service.ServerService.html#env

Attribute

Property

PUBLIC

Undocumented
fiftyone.core.session.client.logger

fiftyone.core.session.client.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.session.client._ping

fiftyone.core.session.client.html#_ping

Function

Function

PRIVATE

Undocumented
fiftyone.core.session.client.Client

fiftyone.core.session.client.Client.html

Class

Class

PUBLIC

No class docstring; 2/2 properties, 0/5 instance variable, 0/5 class variable, 5/8 methods documented
fiftyone.core.session.client.Client.address

fiftyone.core.session.client.Client.html#address

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.client.Client.auto

fiftyone.core.session.client.Client.html#auto

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.client.Client.port

fiftyone.core.session.client.Client.html#port

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.client.Client.remote

fiftyone.core.session.client.Client.html#remote

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.client.Client.start_time

fiftyone.core.session.client.Client.html#start_time

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.client.Client.__post_init__

fiftyone.core.session.client.Client.html#__post_init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.session.client.Client._subscription

fiftyone.core.session.client.Client.html#_subscription

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.session.client.Client._connected

fiftyone.core.session.client.Client.html#_connected

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.session.client.Client._closed

fiftyone.core.session.client.Client.html#_closed

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.session.client.Client._listeners

fiftyone.core.session.client.Client.html#_listeners

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.session.client.Client.origin

fiftyone.core.session.client.Client.html#origin

Attribute

Property

PUBLIC

The origin of the server
fiftyone.core.session.client.Client.is_open

fiftyone.core.session.client.Client.html#is_open

Attribute

Property

PUBLIC

Whether the client is connected
fiftyone.core.session.client.Client.open

fiftyone.core.session.client.Client.html#open

Function

Method

PUBLIC

Open the client connection
fiftyone.core.session.client.Client._thread

fiftyone.core.session.client.Client.html#_thread

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.session.client.Client.close

fiftyone.core.session.client.Client.html#close

Function

Method

PUBLIC

Close the client connection
fiftyone.core.session.client.Client.send_event

fiftyone.core.session.client.Client.html#send_event

Function

Method

PUBLIC

Sends an event to the server
fiftyone.core.session.client.Client.add_event_listener

fiftyone.core.session.client.Client.html#add_event_listener

Function

Method

PUBLIC

Adds an event listener callback for the provided event name. Events sent from client and from the server connection will be dispatched to the listener
fiftyone.core.session.client.Client.remove_event_listener

fiftyone.core.session.client.Client.html#remove_event_listener

Function

Method

PUBLIC

Removes an event listener callback for the provided event name if it has been registered
fiftyone.core.session.client.Client._dispatch_event

fiftyone.core.session.client.Client.html#_dispatch_event

Function

Method

PRIVATE

Undocumented
fiftyone.core.session.client.Client._post_event

fiftyone.core.session.client.Client.html#_post_event

Function

Method

PRIVATE

Undocumented
fiftyone.core.session.notebooks.NotebookCell

fiftyone.core.session.notebooks.NotebookCell.html

Class

Class

PUBLIC

Undocumented
fiftyone.core.session.notebooks.NotebookCell.address

fiftyone.core.session.notebooks.NotebookCell.html#address

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.notebooks.NotebookCell.height

fiftyone.core.session.notebooks.NotebookCell.html#height

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.notebooks.NotebookCell.handle

fiftyone.core.session.notebooks.NotebookCell.html#handle

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.notebooks.NotebookCell.port

fiftyone.core.session.notebooks.NotebookCell.html#port

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.notebooks.NotebookCell.subscription

fiftyone.core.session.notebooks.NotebookCell.html#subscription

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.session.notebooks.capture

fiftyone.core.session.notebooks.html#capture

Function

Function

PUBLIC

Undocumented
fiftyone.core.session.notebooks.display

fiftyone.core.session.notebooks.html#display

Function

Function

PUBLIC

Displays a running FiftyOne instance.
fiftyone.core.session.notebooks.display_ipython

fiftyone.core.session.notebooks.html#display_ipython

Function

Function

PUBLIC

Undocumented
fiftyone.core.session.notebooks.display_colab

fiftyone.core.session.notebooks.html#display_colab

Function

Function

PUBLIC

Display a FiftyOne instance in a Colab output frame.
fiftyone.core.session.notebooks.display_databricks

fiftyone.core.session.notebooks.html#display_databricks

Function

Function

PUBLIC

Display a FiftyOne instance in a Databricks output frame.
fiftyone.core.session.templates.SCREENSHOT_STYLE

fiftyone.core.session.templates.html#SCREENSHOT_STYLE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.session.templates.SCREENSHOT_SCRIPT

fiftyone.core.session.templates.html#SCREENSHOT_SCRIPT

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.session.templates.SCREENSHOT_DIV

fiftyone.core.session.templates.html#SCREENSHOT_DIV

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.session.templates.SCREENSHOT_HTML

fiftyone.core.session.templates.html#SCREENSHOT_HTML

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.session.templates.SCREENSHOT_COLAB

fiftyone.core.session.templates.html#SCREENSHOT_COLAB

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.session.templates.SCREENSHOT_COLAB_SCRIPT

fiftyone.core.session.templates.html#SCREENSHOT_COLAB_SCRIPT

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.session.templates.SCREENSHOT_DATABRICKS_SCRIPT

fiftyone.core.session.templates.html#SCREENSHOT_DATABRICKS_SCRIPT

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.session.templates.SCREENSHOT_DATABRICKS

fiftyone.core.session.templates.html#SCREENSHOT_DATABRICKS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.storage.logger

fiftyone.core.storage.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.storage.FileSystem

fiftyone.core.storage.FileSystem.html

Class

Class

PUBLIC

Enumeration of the available file systems.
fiftyone.core.storage.FileSystem.LOCAL

fiftyone.core.storage.FileSystem.html#LOCAL

Attribute

Constant

PUBLIC

Undocumented
fiftyone.core.storage.get_file_system

fiftyone.core.storage.html#get_file_system

Function

Function

PUBLIC

Returns the file system enum for the given path.
fiftyone.core.storage.split_prefix

fiftyone.core.storage.html#split_prefix

Function

Function

PUBLIC

Splits the file system prefix from the given path.
fiftyone.core.storage.get_bucket_name

fiftyone.core.storage.html#get_bucket_name

Function

Function

PUBLIC

Gets the bucket name from the given path.
fiftyone.core.storage.is_local

fiftyone.core.storage.html#is_local

Function

Function

PUBLIC

Determines whether the given path is local.
fiftyone.core.storage.ensure_local

fiftyone.core.storage.html#ensure_local

Function

Function

PUBLIC

Ensures that the given path is local.
fiftyone.core.storage.normalize_path

fiftyone.core.storage.html#normalize_path

Function

Function

PUBLIC

Normalizes the given path by converting it to an absolute path and expanding the user directory, if necessary.
fiftyone.core.storage.make_temp_dir

fiftyone.core.storage.html#make_temp_dir

Function

Function

PUBLIC

Makes a temporary directory.
fiftyone.core.storage.TempDir

fiftyone.core.storage.TempDir.html

Class

Class

PUBLIC

Context manager that creates and destroys a temporary directory.
fiftyone.core.storage.TempDir.__init__

fiftyone.core.storage.TempDir.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.storage.TempDir._basedir

fiftyone.core.storage.TempDir.html#_basedir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.storage.TempDir._name

fiftyone.core.storage.TempDir.html#_name

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.storage.TempDir.__enter__

fiftyone.core.storage.TempDir.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.core.storage.TempDir.__exit__

fiftyone.core.storage.TempDir.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.core.storage.open_file

fiftyone.core.storage.html#open_file

Function

Function

PUBLIC

Opens the given file for reading or writing.
fiftyone.core.storage.open_files

fiftyone.core.storage.html#open_files

Function

Function

PUBLIC

Opens the given files for reading or writing.
fiftyone.core.storage.read_file

fiftyone.core.storage.html#read_file

Function

Function

PUBLIC

Reads the file.
fiftyone.core.storage.read_files

fiftyone.core.storage.html#read_files

Function

Function

PUBLIC

Reads the specified files into memory.
fiftyone.core.storage.write_file

fiftyone.core.storage.html#write_file

Function

Function

PUBLIC

Writes the given string/bytes to a file.
fiftyone.core.storage.sep

fiftyone.core.storage.html#sep

Function

Function

PUBLIC

Returns the path separator for the given path.
fiftyone.core.storage.join

fiftyone.core.storage.html#join

Function

Function

PUBLIC

Joins the given path components into a single path.
fiftyone.core.storage.realpath

fiftyone.core.storage.html#realpath

Function

Function

PUBLIC

Converts the given path to absolute, resolving symlinks and relative path indicators such as . and ...
fiftyone.core.storage.isabs

fiftyone.core.storage.html#isabs

Function

Function

PUBLIC

Determines whether the given path is absolute.
fiftyone.core.storage.abspath

fiftyone.core.storage.html#abspath

Function

Function

PUBLIC

Converts the given path to an absolute path, resolving relative path indicators such as . and ...
fiftyone.core.storage.normpath

fiftyone.core.storage.html#normpath

Function

Function

PUBLIC

Normalizes the given path by converting all slashes to forward slashes on Unix and backslashes on Windows and removing duplicate slashes.
fiftyone.core.storage.exists

fiftyone.core.storage.html#exists

Function

Function

PUBLIC

Determines whether the given file or directory exists.
fiftyone.core.storage.isfile

fiftyone.core.storage.html#isfile

Function

Function

PUBLIC

Determines whether the given file exists.
fiftyone.core.storage.isdir

fiftyone.core.storage.html#isdir

Function

Function

PUBLIC

Determines whether the given directory exists.
fiftyone.core.storage.make_archive

fiftyone.core.storage.html#make_archive

Function

Function

PUBLIC

Makes an archive containing the given directory.
fiftyone.core.storage.extract_archive

fiftyone.core.storage.html#extract_archive

Function

Function

PUBLIC

Extracts the contents of an archive.
fiftyone.core.storage.ensure_empty_dir

fiftyone.core.storage.html#ensure_empty_dir

Function

Function

PUBLIC

Ensures that the given directory exists and is empty.
fiftyone.core.storage.ensure_basedir

fiftyone.core.storage.html#ensure_basedir

Function

Function

PUBLIC

Makes the base directory of the given path, if necessary.
fiftyone.core.storage.ensure_dir

fiftyone.core.storage.html#ensure_dir

Function

Function

PUBLIC

Makes the given directory, if necessary.
fiftyone.core.storage.load_json

fiftyone.core.storage.html#load_json

Function

Function

PUBLIC

Loads JSON from the input argument.
fiftyone.core.storage.read_json

fiftyone.core.storage.html#read_json

Function

Function

PUBLIC

Reads a JSON file.
fiftyone.core.storage.write_json

fiftyone.core.storage.html#write_json

Function

Function

PUBLIC

Writes JSON object to file.
fiftyone.core.storage.load_ndjson

fiftyone.core.storage.html#load_ndjson

Function

Function

PUBLIC

Loads NDJSON from the input argument.
fiftyone.core.storage.read_ndjson

fiftyone.core.storage.html#read_ndjson

Function

Function

PUBLIC

Reads an NDJSON file.
fiftyone.core.storage.write_ndjson

fiftyone.core.storage.html#write_ndjson

Function

Function

PUBLIC

Writes the list of JSON dicts in NDJSON format.
fiftyone.core.storage.read_yaml

fiftyone.core.storage.html#read_yaml

Function

Function

PUBLIC

Reads a YAML file.
fiftyone.core.storage.write_yaml

fiftyone.core.storage.html#write_yaml

Function

Function

PUBLIC

Writes the object to a YAML file.
fiftyone.core.storage.list_files

fiftyone.core.storage.html#list_files

Function

Function

PUBLIC

Lists the files in the given directory.
fiftyone.core.storage._get_local_metadata

fiftyone.core.storage.html#_get_local_metadata

Function

Function

PRIVATE

Undocumented
fiftyone.core.storage.list_subdirs

fiftyone.core.storage.html#list_subdirs

Function

Function

PUBLIC

Lists the subdirectories in the given directory, sorted alphabetically and excluding hidden directories.
fiftyone.core.storage.list_buckets

fiftyone.core.storage.html#list_buckets

Function

Function

PUBLIC

Lists the available buckets in the given file system.
fiftyone.core.storage.list_available_file_systems

fiftyone.core.storage.html#list_available_file_systems

Function

Function

PUBLIC

Lists the file systems that are currently available for use with methods like list_files and list_buckets.
fiftyone.core.storage.get_glob_matches

fiftyone.core.storage.html#get_glob_matches

Function

Function

PUBLIC

Returns a list of file paths matching the given glob pattern.
fiftyone.core.storage.get_glob_root

fiftyone.core.storage.html#get_glob_root

Function

Function

PUBLIC

Finds the root directory of the given glob pattern, i.e., the deepest subdirectory that contains no glob characters.
fiftyone.core.storage.copy_file

fiftyone.core.storage.html#copy_file

Function

Function

PUBLIC

Copies the input file to the output location.
fiftyone.core.storage.copy_files

fiftyone.core.storage.html#copy_files

Function

Function

PUBLIC

Copies the files to the given locations.
fiftyone.core.storage.copy_dir

fiftyone.core.storage.html#copy_dir

Function

Function

PUBLIC

Copies the input directory to the output directory.
fiftyone.core.storage.move_file

fiftyone.core.storage.html#move_file

Function

Function

PUBLIC

Moves the given file to a new location.
fiftyone.core.storage.move_files

fiftyone.core.storage.html#move_files

Function

Function

PUBLIC

Moves the files to the given locations.
fiftyone.core.storage.move_dir

fiftyone.core.storage.html#move_dir

Function

Function

PUBLIC

Moves the contents of the given directory into the given output directory.
fiftyone.core.storage.delete_file

fiftyone.core.storage.html#delete_file

Function

Function

PUBLIC

Deletes the file at the given path.
fiftyone.core.storage.delete_files

fiftyone.core.storage.html#delete_files

Function

Function

PUBLIC

Deletes the files from the given locations.
fiftyone.core.storage.delete_dir

fiftyone.core.storage.html#delete_dir

Function

Function

PUBLIC

Deletes the given directory and recursively deletes any empty directories from the resulting directory tree.
fiftyone.core.storage.run

fiftyone.core.storage.html#run

Function

Function

PUBLIC

Applies the given function to each element of the given tasks.
fiftyone.core.storage._copy_files

fiftyone.core.storage.html#_copy_files

Function

Function

PRIVATE

Undocumented
fiftyone.core.storage._run

fiftyone.core.storage.html#_run

Function

Function

PRIVATE

Undocumented
fiftyone.core.storage._do_copy_file

fiftyone.core.storage.html#_do_copy_file

Function

Function

PRIVATE

Undocumented
fiftyone.core.storage._do_move_file

fiftyone.core.storage.html#_do_move_file

Function

Function

PRIVATE

Undocumented
fiftyone.core.storage._do_delete_file

fiftyone.core.storage.html#_do_delete_file

Function

Function

PRIVATE

Undocumented
fiftyone.core.storage._do_open_file

fiftyone.core.storage.html#_do_open_file

Function

Function

PRIVATE

Undocumented
fiftyone.core.storage._open_file

fiftyone.core.storage.html#_open_file

Function

Function

PRIVATE

Undocumented
fiftyone.core.storage._do_read_file

fiftyone.core.storage.html#_do_read_file

Function

Function

PRIVATE

Undocumented
fiftyone.core.storage._read_file

fiftyone.core.storage.html#_read_file

Function

Function

PRIVATE

Undocumented
fiftyone.core.storage._copy_file

fiftyone.core.storage.html#_copy_file

Function

Function

PRIVATE

Undocumented
fiftyone.core.storage._delete_file

fiftyone.core.storage.html#_delete_file

Function

Function

PRIVATE

Undocumented
fiftyone.core.storage._to_bytes

fiftyone.core.storage.html#_to_bytes

Function

Function

PRIVATE

Undocumented
fiftyone.core.uid.get_user_id

fiftyone.core.uid.html#get_user_id

Function

Function

PUBLIC

Gets the UUID of the current user.
fiftyone.core.validation.foc

fiftyone.core.validation.html#foc

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.validation.fov

fiftyone.core.validation.html#fov

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.validation.validate_image_sample

fiftyone.core.validation.html#validate_image_sample

Function

Function

PUBLIC

Validates that the sample's media is an image.
fiftyone.core.validation.validate_video_sample

fiftyone.core.validation.html#validate_video_sample

Function

Function

PUBLIC

Validates that the sample's media is a video.
fiftyone.core.validation.validate_collection

fiftyone.core.validation.html#validate_collection

Function

Function

PUBLIC

Validates that the provided samples are a fiftyone.core.collections.SampleCollection.
fiftyone.core.validation.validate_image_collection

fiftyone.core.validation.html#validate_image_collection

Function

Function

PUBLIC

Validates that the provided samples are an image fiftyone.core.collections.SampleCollection.
fiftyone.core.validation.validate_video_collection

fiftyone.core.validation.html#validate_video_collection

Function

Function

PUBLIC

Validates that the provided samples are a video fiftyone.core.collections.SampleCollection.
fiftyone.core.validation.validate_non_grouped_collection

fiftyone.core.validation.html#validate_non_grouped_collection

Function

Function

PUBLIC

Validates that the provided samples are a fiftyone.core.collections.SampleCollection that is not grouped.
fiftyone.core.validation.validate_collection_label_fields

fiftyone.core.validation.html#validate_collection_label_fields

Function

Function

PUBLIC

Validates that the fiftyone.core.collections.SampleCollection has fields with the specified fiftyone.core.labels.Label types.
fiftyone.core.validation._validate_image

fiftyone.core.validation.html#_validate_image

Function

Function

PRIVATE

Undocumented
fiftyone.core.validation._validate_fields

fiftyone.core.validation.html#_validate_fields

Function

Function

PRIVATE

Undocumented
fiftyone.core.validation.get_field

fiftyone.core.validation.html#get_field

Function

Function

PUBLIC

Gets the given sample field and optionally validates its type and value.
fiftyone.core.validation.get_fields

fiftyone.core.validation.html#get_fields

Function

Function

PUBLIC

Gets the given sample fields and optionally validates their types and values.
fiftyone.core.video.fouv

fiftyone.core.video.html#fouv

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.video.logger

fiftyone.core.video.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.core.video.FrameView

fiftyone.core.video.FrameView.html

Class

Class

PUBLIC

A frame in a FramesView.
fiftyone.core.video.FrameView._sample_id

fiftyone.core.video.FrameView.html#_sample_id

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.video.FrameView._save

fiftyone.core.video.FrameView.html#_save

Function

Method

PRIVATE

Undocumented
fiftyone.core.video.FramesView

fiftyone.core.video.FramesView.html

Class

Class

PUBLIC

A fiftyone.core.view.DatasetView of frames from a video fiftyone.core.dataset.Dataset.
fiftyone.core.video.FramesView.__slots__

fiftyone.core.video.FramesView.html#__slots__

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.core.video.FramesView.__init__

fiftyone.core.video.FramesView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.core.video.FramesView._source_collection

fiftyone.core.video.FramesView.html#_source_collection

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.video.FramesView._frames_stage

fiftyone.core.video.FramesView.html#_frames_stage

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.video.FramesView._frames_dataset

fiftyone.core.video.FramesView.html#_frames_dataset

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.video.FramesView.__stages

fiftyone.core.video.FramesView.html#__stages

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.video.FramesView.__media_type

fiftyone.core.video.FramesView.html#__media_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.video.FramesView.__name

fiftyone.core.video.FramesView.html#__name

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.core.video.FramesView.__copy__

fiftyone.core.video.FramesView.html#__copy__

Function

Method

PUBLIC

Undocumented
fiftyone.core.video.FramesView._base_view

fiftyone.core.video.FramesView.html#_base_view

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.video.FramesView._dataset

fiftyone.core.video.FramesView.html#_dataset

Attribute

Property

PRIVATE

The fiftyone.core.dataset.Dataset that serves the samples in this collection.
fiftyone.core.video.FramesView._root_dataset

fiftyone.core.video.FramesView.html#_root_dataset

Attribute

Property

PRIVATE

The root fiftyone.core.dataset.Dataset from which this collection is derived.
fiftyone.core.video.FramesView._sample_cls

fiftyone.core.video.FramesView.html#_sample_cls

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.video.FramesView._stages

fiftyone.core.video.FramesView.html#_stages

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.video.FramesView._all_stages

fiftyone.core.video.FramesView.html#_all_stages

Attribute

Property

PRIVATE

Undocumented
fiftyone.core.video.FramesView.name

fiftyone.core.video.FramesView.html#name

Attribute

Property

PUBLIC

The name of the view if it is a saved view; otherwise None.
fiftyone.core.video.FramesView.is_saved

fiftyone.core.video.FramesView.html#is_saved

Attribute

Property

PUBLIC

Whether the view is a saved view or not.
fiftyone.core.video.FramesView.media_type

fiftyone.core.video.FramesView.html#media_type

Attribute

Property

PUBLIC

The media type of the view.
fiftyone.core.video.FramesView._set_name

fiftyone.core.video.FramesView.html#_set_name

Function

Method

PRIVATE

Undocumented
fiftyone.core.video.FramesView._set_media_type

fiftyone.core.video.FramesView.html#_set_media_type

Function

Method

PRIVATE

Undocumented
fiftyone.core.video.FramesView._get_sample_only_fields

fiftyone.core.video.FramesView.html#_get_sample_only_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.video.FramesView._tag_labels

fiftyone.core.video.FramesView.html#_tag_labels

Function

Method

PRIVATE

Undocumented
fiftyone.core.video.FramesView._untag_labels

fiftyone.core.video.FramesView.html#_untag_labels

Function

Method

PRIVATE

Undocumented
fiftyone.core.video.FramesView.set_values

fiftyone.core.video.FramesView.html#set_values

Function

Method

PUBLIC

Sets the field or embedded field on each sample or frame in the collection to the given values.
fiftyone.core.video.FramesView.set_label_values

fiftyone.core.video.FramesView.html#set_label_values

Function

Method

PUBLIC

Sets the fields of the specified labels in the collection to the given values.
fiftyone.core.video.FramesView.save

fiftyone.core.video.FramesView.html#save

Function

Method

PUBLIC

Saves the frames in this view to the underlying dataset.
fiftyone.core.video.FramesView.keep

fiftyone.core.video.FramesView.html#keep

Function

Method

PUBLIC

Deletes all frames that are not in this view from the underlying dataset.
fiftyone.core.video.FramesView.keep_fields

fiftyone.core.video.FramesView.html#keep_fields

Function

Method

PUBLIC

Deletes any sample fields that have been excluded in this view from the frames of the underlying dataset.
fiftyone.core.video.FramesView.reload

fiftyone.core.video.FramesView.html#reload

Function

Method

PUBLIC

Reloads the view.
fiftyone.core.video.FramesView._set_labels

fiftyone.core.video.FramesView.html#_set_labels

Function

Method

PRIVATE

Undocumented
fiftyone.core.video.FramesView._delete_labels

fiftyone.core.video.FramesView.html#_delete_labels

Function

Method

PRIVATE

Undocumented
fiftyone.core.video.FramesView._sync_source_sample

fiftyone.core.video.FramesView.html#_sync_source_sample

Function

Method

PRIVATE

Undocumented
fiftyone.core.video.FramesView._sync_source

fiftyone.core.video.FramesView.html#_sync_source

Function

Method

PRIVATE

Undocumented
fiftyone.core.video.FramesView._sync_source_field_schema

fiftyone.core.video.FramesView.html#_sync_source_field_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.video.FramesView._sync_source_schema

fiftyone.core.video.FramesView.html#_sync_source_schema

Function

Method

PRIVATE

Undocumented
fiftyone.core.video.FramesView._sync_source_keep_fields

fiftyone.core.video.FramesView.html#_sync_source_keep_fields

Function

Method

PRIVATE

Undocumented
fiftyone.core.video.make_frames_dataset

fiftyone.core.video.html#make_frames_dataset

Function

Function

PUBLIC

Creates a dataset that contains one sample per frame in the video collection.
fiftyone.core.video._make_pretty_summary

fiftyone.core.video.html#_make_pretty_summary

Function

Function

PRIVATE

Undocumented
fiftyone.core.video._init_frames

fiftyone.core.video.html#_init_frames

Function

Function

PRIVATE

Undocumented
fiftyone.core.video._insert_docs

fiftyone.core.video.html#_insert_docs

Function

Function

PRIVATE

Undocumented
fiftyone.core.video._parse_video_frames

fiftyone.core.video.html#_parse_video_frames

Function

Function

PRIVATE

Undocumented
fiftyone.core.video._get_non_existent_frame_numbers

fiftyone.core.video.html#_get_non_existent_frame_numbers

Function

Function

PRIVATE

Undocumented
fiftyone.factory.SortByField

fiftyone.factory.SortByField.html

Class

Class

PUBLIC

Sort by enum for delegated operations.
fiftyone.factory.SortByField.UPDATED_AT

fiftyone.factory.SortByField.html#UPDATED_AT

Attribute

Constant

PUBLIC

Undocumented
fiftyone.factory.SortByField.SCHEDULED_AT

fiftyone.factory.SortByField.html#SCHEDULED_AT

Attribute

Constant

PUBLIC

Undocumented
fiftyone.factory.SortByField.QUEUED_AT

fiftyone.factory.SortByField.html#QUEUED_AT

Attribute

Constant

PUBLIC

Undocumented
fiftyone.factory.SortByField.COMPLETED_AT

fiftyone.factory.SortByField.html#COMPLETED_AT

Attribute

Constant

PUBLIC

Undocumented
fiftyone.factory.SortByField.STARTED_AT

fiftyone.factory.SortByField.html#STARTED_AT

Attribute

Constant

PUBLIC

Undocumented
fiftyone.factory.SortByField.FAILED_AT

fiftyone.factory.SortByField.html#FAILED_AT

Attribute

Constant

PUBLIC

Undocumented
fiftyone.factory.SortByField.OPERATOR

fiftyone.factory.SortByField.html#OPERATOR

Attribute

Constant

PUBLIC

Undocumented
fiftyone.factory.SortDirection

fiftyone.factory.SortDirection.html

Class

Class

PUBLIC

Sort direction enum for delegated operations.
fiftyone.factory.SortDirection.ASCENDING

fiftyone.factory.SortDirection.html#ASCENDING

Attribute

Constant

PUBLIC

Undocumented
fiftyone.factory.SortDirection.DESCENDING

fiftyone.factory.SortDirection.html#DESCENDING

Attribute

Constant

PUBLIC

Undocumented
fiftyone.factory.DelegatedOperationPagingParams

fiftyone.factory.DelegatedOperationPagingParams.html

Class

Class

PUBLIC

Paging parameters for delegated operations.
fiftyone.factory.DelegatedOperationPagingParams.__init__

fiftyone.factory.DelegatedOperationPagingParams.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.factory.DelegatedOperationPagingParams.sort_by

fiftyone.factory.DelegatedOperationPagingParams.html#sort_by

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.DelegatedOperationPagingParams.sort_direction

fiftyone.factory.DelegatedOperationPagingParams.html#sort_direction

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.DelegatedOperationPagingParams.skip

fiftyone.factory.DelegatedOperationPagingParams.html#skip

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.DelegatedOperationPagingParams.limit

fiftyone.factory.DelegatedOperationPagingParams.html#limit

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.internal.util.is_remote_service

fiftyone.internal.util.html#is_remote_service

Function

Function

PUBLIC

Whether the SDK is running in a remote service context.
fiftyone.internal.util.has_encryption_key

fiftyone.internal.util.html#has_encryption_key

Function

Function

PUBLIC

Whether the current environment has an encryption key.
fiftyone.internal.util.has_api_key

fiftyone.internal.util.html#has_api_key

Function

Function

PUBLIC

Whether the current environment has an API key.
fiftyone.plugins.definitions.PluginDefinition

fiftyone.plugins.definitions.PluginDefinition.html

Class

Class

PUBLIC

A plugin definition.
fiftyone.plugins.definitions.PluginDefinition._REQUIRED_METADATA_KEYS

fiftyone.plugins.definitions.PluginDefinition.html#_REQUIRED_METADATA_KEYS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.plugins.definitions.PluginDefinition.__init__

fiftyone.plugins.definitions.PluginDefinition.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.definitions.PluginDefinition._directory

fiftyone.plugins.definitions.PluginDefinition.html#_directory

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.plugins.definitions.PluginDefinition._metadata

fiftyone.plugins.definitions.PluginDefinition.html#_metadata

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.plugins.definitions.PluginDefinition._shadow_paths

fiftyone.plugins.definitions.PluginDefinition.html#_shadow_paths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.plugins.definitions.PluginDefinition.name

fiftyone.plugins.definitions.PluginDefinition.html#name

Attribute

Property

PUBLIC

The name of the plugin.
fiftyone.plugins.definitions.PluginDefinition.directory

fiftyone.plugins.definitions.PluginDefinition.html#directory

Attribute

Property

PUBLIC

The directory containing the plugin.
fiftyone.plugins.definitions.PluginDefinition.builtin

fiftyone.plugins.definitions.PluginDefinition.html#builtin

Attribute

Property

PUBLIC

Whether the plugin is a builtin plugin.
fiftyone.plugins.definitions.PluginDefinition.shadow_paths

fiftyone.plugins.definitions.PluginDefinition.html#shadow_paths

Attribute

Property

PUBLIC

A list of plugin directories that this plugin shadows.
fiftyone.plugins.definitions.PluginDefinition.author

fiftyone.plugins.definitions.PluginDefinition.html#author

Attribute

Property

PUBLIC

The author of the plugin.
fiftyone.plugins.definitions.PluginDefinition.version

fiftyone.plugins.definitions.PluginDefinition.html#version

Attribute

Property

PUBLIC

The version of the plugin.
fiftyone.plugins.definitions.PluginDefinition.url

fiftyone.plugins.definitions.PluginDefinition.html#url

Attribute

Property

PUBLIC

The URL of the plugin.
fiftyone.plugins.definitions.PluginDefinition.license

fiftyone.plugins.definitions.PluginDefinition.html#license

Attribute

Property

PUBLIC

The license of the plugin.
fiftyone.plugins.definitions.PluginDefinition.description

fiftyone.plugins.definitions.PluginDefinition.html#description

Attribute

Property

PUBLIC

The description of the plugin.
fiftyone.plugins.definitions.PluginDefinition.fiftyone_compatibility

fiftyone.plugins.definitions.PluginDefinition.html#fiftyone_compatibility

Attribute

Property

PUBLIC

The FiftyOne compatibility version.
fiftyone.plugins.definitions.PluginDefinition.fiftyone_requirement

fiftyone.plugins.definitions.PluginDefinition.html#fiftyone_requirement

Attribute

Property

PUBLIC

The FiftyOne requirement as a string like fiftyone>=0.21.
fiftyone.plugins.definitions.PluginDefinition.operators

fiftyone.plugins.definitions.PluginDefinition.html#operators

Attribute

Property

PUBLIC

The operators of the plugin.
fiftyone.plugins.definitions.PluginDefinition.package_json_path

fiftyone.plugins.definitions.PluginDefinition.html#package_json_path

Attribute

Property

PUBLIC

The absolute path to the package.json file.
fiftyone.plugins.definitions.PluginDefinition.has_package_json

fiftyone.plugins.definitions.PluginDefinition.html#has_package_json

Attribute

Property

PUBLIC

Whether the plugin has a package.json file.
fiftyone.plugins.definitions.PluginDefinition.js_bundle

fiftyone.plugins.definitions.PluginDefinition.html#js_bundle

Attribute

Property

PUBLIC

The relative path to the JS bundle file.
fiftyone.plugins.definitions.PluginDefinition.js_bundle_path

fiftyone.plugins.definitions.PluginDefinition.html#js_bundle_path

Attribute

Property

PUBLIC

Undocumented
fiftyone.plugins.definitions.PluginDefinition.py_entry

fiftyone.plugins.definitions.PluginDefinition.html#py_entry

Attribute

Property

PUBLIC

Undocumented
fiftyone.plugins.definitions.PluginDefinition.py_entry_path

fiftyone.plugins.definitions.PluginDefinition.html#py_entry_path

Attribute

Property

PUBLIC

The absolute path to the Python entry file.
fiftyone.plugins.definitions.PluginDefinition.server_path

fiftyone.plugins.definitions.PluginDefinition.html#server_path

Attribute

Property

PUBLIC

The default server path to the plugin.
fiftyone.plugins.definitions.PluginDefinition.js_bundle_server_path

fiftyone.plugins.definitions.PluginDefinition.html#js_bundle_server_path

Attribute

Property

PUBLIC

The default server path to the JS bundle.
fiftyone.plugins.definitions.PluginDefinition.js_bundle_hash

fiftyone.plugins.definitions.PluginDefinition.html#js_bundle_hash

Attribute

Property

PUBLIC

A hash of the plugin's JS bundle file.
fiftyone.plugins.definitions.PluginDefinition.can_register_operator

fiftyone.plugins.definitions.PluginDefinition.html#can_register_operator

Function

Method

PUBLIC

Whether the plugin can register the given operator.
fiftyone.plugins.definitions.PluginDefinition.has_py

fiftyone.plugins.definitions.PluginDefinition.html#has_py

Attribute

Property

PUBLIC

Whether the plugin has a Python entry file.
fiftyone.plugins.definitions.PluginDefinition.has_js

fiftyone.plugins.definitions.PluginDefinition.html#has_js

Attribute

Property

PUBLIC

Whether the plugin has a JS bundle file.
fiftyone.plugins.definitions.PluginDefinition.secrets

fiftyone.plugins.definitions.PluginDefinition.html#secrets

Attribute

Property

PUBLIC

A list of required secrets for the plugin.
fiftyone.plugins.definitions.PluginDefinition.to_dict

fiftyone.plugins.definitions.PluginDefinition.html#to_dict

Function

Method

PUBLIC

Returns a JSON dict representation of the plugin metadata.
fiftyone.plugins.definitions.PluginDefinition.from_disk

fiftyone.plugins.definitions.PluginDefinition.html#from_disk

Function

Class Method

PUBLIC

Creates a PluginDefinition for the given metadata file.
fiftyone.plugins.definitions.PluginDefinition._validate

fiftyone.plugins.definitions.PluginDefinition.html#_validate

Function

Method

PRIVATE

Undocumented
fiftyone.plugins.definitions.PluginDefinition._get_abs_path

fiftyone.plugins.definitions.PluginDefinition.html#_get_abs_path

Function

Method

PRIVATE

Undocumented
fiftyone.utils.github.logger

fiftyone.utils.github.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.github.GitHubRepository

fiftyone.utils.github.GitHubRepository.html

Class

Class

PUBLIC

Class for interacting with a GitHub repository.
fiftyone.utils.github.GitHubRepository.__init__

fiftyone.utils.github.GitHubRepository.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.github.GitHubRepository._user

fiftyone.utils.github.GitHubRepository.html#_user

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.github.GitHubRepository._repo

fiftyone.utils.github.GitHubRepository.html#_repo

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.github.GitHubRepository._ref

fiftyone.utils.github.GitHubRepository.html#_ref

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.github.GitHubRepository._safe_path

fiftyone.utils.github.GitHubRepository.html#_safe_path

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.github.GitHubRepository._session

fiftyone.utils.github.GitHubRepository.html#_session

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.github.GitHubRepository._handle_safe_path

fiftyone.utils.github.GitHubRepository.html#_handle_safe_path

Function

Method

PRIVATE

Undocumented
fiftyone.utils.github.GitHubRepository.user

fiftyone.utils.github.GitHubRepository.html#user

Attribute

Property

PUBLIC

The username of the repo.
fiftyone.utils.github.GitHubRepository.repo

fiftyone.utils.github.GitHubRepository.html#repo

Attribute

Property

PUBLIC

The name of the repo.
fiftyone.utils.github.GitHubRepository.ref

fiftyone.utils.github.GitHubRepository.html#ref

Attribute

Property

PUBLIC

The ref (e.g. branch, tag, commit hash), if any.
fiftyone.utils.github.GitHubRepository.safe_path

fiftyone.utils.github.GitHubRepository.html#safe_path

Attribute

Property

PUBLIC

The path that was extracted from the provided ref, if any.
fiftyone.utils.github.GitHubRepository.identifier

fiftyone.utils.github.GitHubRepository.html#identifier

Attribute

Property

PUBLIC

The repository identifier string.
fiftyone.utils.github.GitHubRepository.get_repo_info

fiftyone.utils.github.GitHubRepository.html#get_repo_info

Function

Method

PUBLIC

Returns a dict of info about the repository.
fiftyone.utils.github.GitHubRepository.get_file

fiftyone.utils.github.GitHubRepository.html#get_file

Function

Method

PUBLIC

Downloads the file at the given path.
fiftyone.utils.github.GitHubRepository.list_path_contents

fiftyone.utils.github.GitHubRepository.html#list_path_contents

Function

Method

PUBLIC

Returns the contents of the repo rooted at the given path.
fiftyone.utils.github.GitHubRepository.list_repo_contents

fiftyone.utils.github.GitHubRepository.html#list_repo_contents

Function

Method

PUBLIC

Returns a flat list of the repository's contents.
fiftyone.utils.github.GitHubRepository.download

fiftyone.utils.github.GitHubRepository.html#download

Function

Method

PUBLIC

Downloads the repository to the specified root directory.
fiftyone.utils.github.GitHubRepository._get_session

fiftyone.utils.github.GitHubRepository.html#_get_session

Function

Method

PRIVATE

Undocumented
fiftyone.utils.github.GitHubRepository._make_session

fiftyone.utils.github.GitHubRepository.html#_make_session

Function

Method

PRIVATE

Undocumented
fiftyone.utils.github.GitHubRepository._get_token

fiftyone.utils.github.GitHubRepository.html#_get_token

Function

Method

PRIVATE

Undocumented
fiftyone.utils.github.GitHubRepository._get

fiftyone.utils.github.GitHubRepository.html#_get

Function

Method

PRIVATE

Undocumented
fiftyone.utils.github.GitHubRepository.parse_url

fiftyone.utils.github.GitHubRepository.html#parse_url

Function

Static Method

PUBLIC

Undocumented
fiftyone.utils.github.GitHubRepository.parse_identifier

fiftyone.utils.github.GitHubRepository.html#parse_identifier

Function

Static Method

PUBLIC

Undocumented
fiftyone.plugins.core.PLUGIN_METADATA_FILENAMES

fiftyone.plugins.core.html#PLUGIN_METADATA_FILENAMES

Attribute

Constant

PUBLIC

Undocumented
fiftyone.plugins.core.logger

fiftyone.plugins.core.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.plugins.core.PluginPackage

fiftyone.plugins.core.PluginPackage.html

Class

Class

PUBLIC

Plugin package.
fiftyone.plugins.core.PluginPackage.name

fiftyone.plugins.core.PluginPackage.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.plugins.core.PluginPackage.path

fiftyone.plugins.core.PluginPackage.html#path

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.plugins.core.PluginPackage.shadow_paths

fiftyone.plugins.core.PluginPackage.html#shadow_paths

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.plugins.core.PluginPackage.__repr__

fiftyone.plugins.core.PluginPackage.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.core.list_plugins

fiftyone.plugins.core.html#list_plugins

Function

Function

PUBLIC

Lists available plugins.
fiftyone.plugins.core.enable_plugin

fiftyone.plugins.core.html#enable_plugin

Function

Function

PUBLIC

Enables the given plugin.
fiftyone.plugins.core.disable_plugin

fiftyone.plugins.core.html#disable_plugin

Function

Function

PUBLIC

Disables the given plugin.
fiftyone.plugins.core.delete_plugin

fiftyone.plugins.core.html#delete_plugin

Function

Function

PUBLIC

Deletes the given plugin from local disk.
fiftyone.plugins.core.list_downloaded_plugins

fiftyone.plugins.core.html#list_downloaded_plugins

Function

Function

PUBLIC

Returns a list of all downloaded plugin names.
fiftyone.plugins.core.list_enabled_plugins

fiftyone.plugins.core.html#list_enabled_plugins

Function

Function

PUBLIC

Returns a list of all enabled plugin names.
fiftyone.plugins.core.list_disabled_plugins

fiftyone.plugins.core.html#list_disabled_plugins

Function

Function

PUBLIC

Returns a list of all disabled plugin names.
fiftyone.plugins.core.get_plugin

fiftyone.plugins.core.html#get_plugin

Function

Function

PUBLIC

Gets the definition for the given plugin.
fiftyone.plugins.core.find_plugin

fiftyone.plugins.core.html#find_plugin

Function

Function

PUBLIC

Returns the path to the plugin on local disk.
fiftyone.plugins.core.download_plugin

fiftyone.plugins.core.html#download_plugin

Function

Function

PUBLIC

Downloads the plugin(s) from the given location to your local plugins directory (fo.config.plugins_dir).
fiftyone.plugins.core._download_archive

fiftyone.plugins.core.html#_download_archive

Function

Function

PRIVATE

Undocumented
fiftyone.plugins.core.load_plugin_requirements

fiftyone.plugins.core.html#load_plugin_requirements

Function

Function

PUBLIC

Loads the Python package requirements associated with the given plugin, if any.
fiftyone.plugins.core.install_plugin_requirements

fiftyone.plugins.core.html#install_plugin_requirements

Function

Function

PUBLIC

Installs any Python package requirements associated with the given plugin.
fiftyone.plugins.core.ensure_plugin_requirements

fiftyone.plugins.core.html#ensure_plugin_requirements

Function

Function

PUBLIC

Ensures that any Python package requirements associated with the given plugin are installed.
fiftyone.plugins.core._find_requirements

fiftyone.plugins.core.html#_find_requirements

Function

Function

PRIVATE

Undocumented
fiftyone.plugins.core.ensure_plugin_compatibility

fiftyone.plugins.core.html#ensure_plugin_compatibility

Function

Function

PUBLIC

Ensures that the given plugin is compatible with your current FiftyOne package version.
fiftyone.plugins.core.create_plugin

fiftyone.plugins.core.html#create_plugin

Function

Function

PUBLIC

Creates a plugin with the given name.
fiftyone.plugins.core._find_plugin_metadata_file

fiftyone.plugins.core.html#_find_plugin_metadata_file

Function

Function

PRIVATE

Undocumented
fiftyone.plugins.core._parse_plugin_metadata

fiftyone.plugins.core.html#_parse_plugin_metadata

Function

Function

PRIVATE

Undocumented
fiftyone.plugins.core._list_plugins

fiftyone.plugins.core.html#_list_plugins

Function

Function

PRIVATE

Undocumented
fiftyone.plugins.core._handle_shadowed

fiftyone.plugins.core.html#_handle_shadowed

Function

Function

PRIVATE

Undocumented
fiftyone.plugins.core._iter_plugin_metadata_files

fiftyone.plugins.core.html#_iter_plugin_metadata_files

Function

Function

PRIVATE

Undocumented
fiftyone.plugins.core._get_plugin

fiftyone.plugins.core.html#_get_plugin

Function

Function

PRIVATE

Undocumented
fiftyone.plugins.core._load_plugin_definition

fiftyone.plugins.core.html#_load_plugin_definition

Function

Function

PRIVATE

Undocumented
fiftyone.plugins.core._list_disabled_plugins

fiftyone.plugins.core.html#_list_disabled_plugins

Function

Function

PRIVATE

Undocumented
fiftyone.plugins.core._recommend_plugin_dir

fiftyone.plugins.core.html#_recommend_plugin_dir

Function

Function

PRIVATE

Undocumented
fiftyone.plugins.core._recommend_label

fiftyone.plugins.core.html#_recommend_label

Function

Function

PRIVATE

Undocumented
fiftyone.plugins.core._update_plugin_settings

fiftyone.plugins.core.html#_update_plugin_settings

Function

Function

PRIVATE

Undocumented
fiftyone.operators.decorators.coroutine_timeout

fiftyone.operators.decorators.html#coroutine_timeout

Function

Function

PUBLIC

Undocumented
fiftyone.operators.decorators.timeout

fiftyone.operators.decorators.html#timeout

Function

Function

PUBLIC

Undocumented
fiftyone.operators.decorators.raise_timeout_error

fiftyone.operators.decorators.html#raise_timeout_error

Function

Function

PUBLIC

Undocumented
fiftyone.operators.decorators.cache

fiftyone.operators.decorators.html#cache

Attribute

Variable

PUBLIC

Undocumented
fiftyone.operators.decorators.dir_cache

fiftyone.operators.decorators.html#dir_cache

Attribute

Variable

PUBLIC

Undocumented
fiftyone.operators.decorators.plugins_cache

fiftyone.operators.decorators.html#plugins_cache

Function

Function

PUBLIC

Decorator that returns cached function results as long as no plugins have been modified since last time.
fiftyone.operators.decorators.dir_state

fiftyone.operators.decorators.html#dir_state

Function

Function

PUBLIC

Undocumented
fiftyone.operators.message.MessageType

fiftyone.operators.message.MessageType.html

Class

Class

PUBLIC

Message types.
fiftyone.operators.message.MessageType.SUCCESS

fiftyone.operators.message.MessageType.html#SUCCESS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.message.MessageType.ERROR

fiftyone.operators.message.MessageType.html#ERROR

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.message.GeneratedMessage

fiftyone.operators.message.GeneratedMessage.html

Class

Class

PUBLIC

A message generated by an operator executed as a generator.
fiftyone.operators.message.GeneratedMessage.__init__

fiftyone.operators.message.GeneratedMessage.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.message.GeneratedMessage.type

fiftyone.operators.message.GeneratedMessage.html#type

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.message.GeneratedMessage.cls

fiftyone.operators.message.GeneratedMessage.html#cls

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.message.GeneratedMessage.body

fiftyone.operators.message.GeneratedMessage.html#body

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.message.GeneratedMessage.to_json

fiftyone.operators.message.GeneratedMessage.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.message.GeneratedMessage.to_json_line

fiftyone.operators.message.GeneratedMessage.html#to_json_line

Function

Method

PUBLIC

Undocumented
fiftyone.operators.categories.Categories

fiftyone.operators.categories.Categories.html

Class

Class

PUBLIC

Undocumented
fiftyone.operators.categories.Categories.IMPORT

fiftyone.operators.categories.Categories.html#IMPORT

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.categories.Categories.CURATE

fiftyone.operators.categories.Categories.html#CURATE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.categories.Categories.ANALYZE

fiftyone.operators.categories.Categories.html#ANALYZE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.categories.Categories.CUSTOM

fiftyone.operators.categories.Categories.html#CUSTOM

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.operations.Operations

fiftyone.operators.operations.Operations.html

Class

Class

PUBLIC

Interface to trigger builtin operations on an execution context.
fiftyone.operators.operations.Operations.__init__

fiftyone.operators.operations.Operations.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.operations.Operations._ctx

fiftyone.operators.operations.Operations.html#_ctx

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.operations.Operations.clone_selected_samples

fiftyone.operators.operations.Operations.html#clone_selected_samples

Function

Method

PUBLIC

Clone the selected samples in the App.
fiftyone.operators.operations.Operations.clone_sample_field

fiftyone.operators.operations.Operations.html#clone_sample_field

Function

Method

PUBLIC

Clone a sample field to a new field name.
fiftyone.operators.operations.Operations.rename_sample_field

fiftyone.operators.operations.Operations.html#rename_sample_field

Function

Method

PUBLIC

Rename a sample field to a new field name.
fiftyone.operators.operations.Operations.clear_sample_field

fiftyone.operators.operations.Operations.html#clear_sample_field

Function

Method

PUBLIC

Clear the contents of a sample field.
fiftyone.operators.operations.Operations.delete_selected_samples

fiftyone.operators.operations.Operations.html#delete_selected_samples

Function

Method

PUBLIC

Delete the selected samples in the App.
fiftyone.operators.operations.Operations.delete_selected_labels

fiftyone.operators.operations.Operations.html#delete_selected_labels

Function

Method

PUBLIC

Delete the selected labels in the App.
fiftyone.operators.operations.Operations.delete_sample_field

fiftyone.operators.operations.Operations.html#delete_sample_field

Function

Method

PUBLIC

Delete a sample field.
fiftyone.operators.operations.Operations.print_stdout

fiftyone.operators.operations.Operations.html#print_stdout

Function

Method

PUBLIC

Print a message to the standard output.
fiftyone.operators.operations.Operations.list_files

fiftyone.operators.operations.Operations.html#list_files

Function

Method

PUBLIC

List files in a directory or list filesystems.
fiftyone.operators.operations.Operations.reload_samples

fiftyone.operators.operations.Operations.html#reload_samples

Function

Method

PUBLIC

Reload the sample grid in the App.
fiftyone.operators.operations.Operations.reload_dataset

fiftyone.operators.operations.Operations.html#reload_dataset

Function

Method

PUBLIC

Reload the dataset in the App.
fiftyone.operators.operations.Operations.clear_selected_samples

fiftyone.operators.operations.Operations.html#clear_selected_samples

Function

Method

PUBLIC

Clear selected samples in the App.
fiftyone.operators.operations.Operations.copy_view_as_json

fiftyone.operators.operations.Operations.html#copy_view_as_json

Function

Method

PUBLIC

Copy the current view in the App as JSON.
fiftyone.operators.operations.Operations.view_from_json

fiftyone.operators.operations.Operations.html#view_from_json

Function

Method

PUBLIC

Set the view in the App from JSON present in clipboard.
fiftyone.operators.operations.Operations._create_panel_params

fiftyone.operators.operations.Operations.html#_create_panel_params

Function

Method

PRIVATE

Undocumented
fiftyone.operators.operations.Operations.clear_panel_state

fiftyone.operators.operations.Operations.html#clear_panel_state

Function

Method

PUBLIC

Clear the state of the specified panel in the App.
fiftyone.operators.operations.Operations.clear_panel_data

fiftyone.operators.operations.Operations.html#clear_panel_data

Function

Method

PUBLIC

Clear the data of the specified panel in the App.
fiftyone.operators.operations.Operations.set_panel_state

fiftyone.operators.operations.Operations.html#set_panel_state

Function

Method

PUBLIC

Set the entire state of the specified panel in the App.
fiftyone.operators.operations.Operations.set_panel_data

fiftyone.operators.operations.Operations.html#set_panel_data

Function

Method

PUBLIC

Set the entire data of the specified panel in the App.
fiftyone.operators.operations.Operations.patch_panel_state

fiftyone.operators.operations.Operations.html#patch_panel_state

Function

Method

PUBLIC

Patch the state of the specified panel in the App.
fiftyone.operators.operations.Operations.patch_panel_data

fiftyone.operators.operations.Operations.html#patch_panel_data

Function

Method

PUBLIC

Patch the state of the specified panel in the App.
fiftyone.operators.operations.Operations.reduce_panel_state

fiftyone.operators.operations.Operations.html#reduce_panel_state

Function

Method

PUBLIC

Reduce the state of the specified panel in the App.
fiftyone.operators.operations.Operations.apply_panel_state_path

fiftyone.operators.operations.Operations.html#apply_panel_state_path

Function

Method

PUBLIC

Force update the state for path in the specified panel in the App.
fiftyone.operators.operations.Operations.show_panel_output

fiftyone.operators.operations.Operations.html#show_panel_output

Function

Method

PUBLIC

Show output in the specified panel in the App.
fiftyone.operators.operations.Operations.open_panel

fiftyone.operators.operations.Operations.html#open_panel

Function

Method

PUBLIC

Open a panel with the given name and layout options in the App.
fiftyone.operators.operations.Operations.register_panel

fiftyone.operators.operations.Operations.html#register_panel

Function

Method

PUBLIC

Registers a panel with the given name and lifecycle callbacks.
fiftyone.operators.operations.Operations.open_all_panels

fiftyone.operators.operations.Operations.html#open_all_panels

Function

Method

PUBLIC

Open all available panels in the App.
fiftyone.operators.operations.Operations.close_panel

fiftyone.operators.operations.Operations.html#close_panel

Function

Method

PUBLIC

Close the given panel in the App.
fiftyone.operators.operations.Operations.close_all_panels

fiftyone.operators.operations.Operations.html#close_all_panels

Function

Method

PUBLIC

Close all open panels in the App.
fiftyone.operators.operations.Operations.split_panel

fiftyone.operators.operations.Operations.html#split_panel

Function

Method

PUBLIC

Split the panel with the given layout in the App.
fiftyone.operators.operations.Operations.open_dataset

fiftyone.operators.operations.Operations.html#open_dataset

Function

Method

PUBLIC

Open the specified dataset in the App.
fiftyone.operators.operations.Operations.clear_view

fiftyone.operators.operations.Operations.html#clear_view

Function

Method

PUBLIC

Clear the view bar in the App.
fiftyone.operators.operations.Operations.clear_sidebar_filters

fiftyone.operators.operations.Operations.html#clear_sidebar_filters

Function

Method

PUBLIC

Clear all filters in the App's sidebar.
fiftyone.operators.operations.Operations.clear_all_stages

fiftyone.operators.operations.Operations.html#clear_all_stages

Function

Method

PUBLIC

Clear all selections, filters, and view stages from the App.
fiftyone.operators.operations.Operations.refresh_colors

fiftyone.operators.operations.Operations.html#refresh_colors

Function

Method

PUBLIC

Refresh the colors used in the App's UI.
fiftyone.operators.operations.Operations.show_selected_samples

fiftyone.operators.operations.Operations.html#show_selected_samples

Function

Method

PUBLIC

Show the samples that are currently selected in the App.
fiftyone.operators.operations.Operations.convert_extended_selection_to_selected_samples

fiftyone.operators.operations.Operations.html#convert_extended_selection_to_selected_samples

Function

Method

PUBLIC

Convert the extended selection to selected samples in the App.
fiftyone.operators.operations.Operations.set_selected_samples

fiftyone.operators.operations.Operations.html#set_selected_samples

Function

Method

PUBLIC

Select the specified samples in the App.
fiftyone.operators.operations.Operations.set_view

fiftyone.operators.operations.Operations.html#set_view

Function

Method

PUBLIC

Set the current view in the App.
fiftyone.operators.operations.Operations.show_samples

fiftyone.operators.operations.Operations.html#show_samples

Function

Method

PUBLIC

Show specific samples, optionally using extended selection in the App.
fiftyone.operators.operations.Operations.console_log

fiftyone.operators.operations.Operations.html#console_log

Function

Method

PUBLIC

Log a message to the console.
fiftyone.operators.operations.Operations.show_output

fiftyone.operators.operations.Operations.html#show_output

Function

Method

PUBLIC

Show output in the App's UI.
fiftyone.operators.operations.Operations.set_progress

fiftyone.operators.operations.Operations.html#set_progress

Function

Method

PUBLIC

Set the progress indicator in the App's UI.
fiftyone.operators.operations.Operations.test_operator

fiftyone.operators.operations.Operations.html#test_operator

Function

Method

PUBLIC

Test the operator with given parameters.
fiftyone.operators.operations.Operations.set_selected_labels

fiftyone.operators.operations.Operations.html#set_selected_labels

Function

Method

PUBLIC

Set the selected labels in the App.
fiftyone.operators.operations.Operations.clear_selected_labels

fiftyone.operators.operations.Operations.html#clear_selected_labels

Function

Method

PUBLIC

Clear the selected labels in the App.
fiftyone.operators.operations.Operations.notify

fiftyone.operators.operations.Operations.html#notify

Function

Method

PUBLIC

Show a notification in the App.
fiftyone.operators.operations.Operations.set_extended_selection

fiftyone.operators.operations.Operations.html#set_extended_selection

Function

Method

PUBLIC

Sets the extended selection in the App.
fiftyone.operators.operations.Operations.set_spaces

fiftyone.operators.operations.Operations.html#set_spaces

Function

Method

PUBLIC

Sets the current spaces in the App.
fiftyone.operators.operations.Operations.set_active_fields

fiftyone.operators.operations.Operations.html#set_active_fields

Function

Method

PUBLIC

Set the active fields in the App.
fiftyone.operators.operations.Operations.track_event

fiftyone.operators.operations.Operations.html#track_event

Function

Method

PUBLIC

Track an event in the App.
fiftyone.operators.operations.Operations.set_panel_title

fiftyone.operators.operations.Operations.html#set_panel_title

Function

Method

PUBLIC

Set the title of the specified panel in the App.
fiftyone.operators.operations.Operations.set_group_slice

fiftyone.operators.operations.Operations.html#set_group_slice

Function

Method

PUBLIC

Set the active group slice in the App.
fiftyone.operators.operations.Operations.open_sample

fiftyone.operators.operations.Operations.html#open_sample

Function

Method

PUBLIC

Opens the specified sample or group in the App's sample modal.
fiftyone.operators.operations.Operations.close_sample

fiftyone.operators.operations.Operations.html#close_sample

Function

Method

PUBLIC

Closes the App's sample modal.
fiftyone.operators.operations.Operations.show_sidebar

fiftyone.operators.operations.Operations.html#show_sidebar

Function

Method

PUBLIC

Show the App's sidebar.
fiftyone.operators.operations.Operations.hide_sidebar

fiftyone.operators.operations.Operations.html#hide_sidebar

Function

Method

PUBLIC

Hide the App's sidebar.
fiftyone.operators.operations.Operations.toggle_sidebar

fiftyone.operators.operations.Operations.html#toggle_sidebar

Function

Method

PUBLIC

Toggle the visibility of the App's sidebar.
fiftyone.operators.operations._serialize_view

fiftyone.operators.operations.html#_serialize_view

Function

Function

PRIVATE

Undocumented
fiftyone.operators.types.BaseType

fiftyone.operators.types.BaseType.html

Class

Class

PUBLIC

Base class for all types.
fiftyone.operators.types.BaseType.to_json

fiftyone.operators.types.BaseType.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Void

fiftyone.operators.types.Void.html

Class

Class

PUBLIC

Represents a void type.
fiftyone.operators.types.Void.__init__

fiftyone.operators.types.Void.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Void.to_json

fiftyone.operators.types.Void.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Object

fiftyone.operators.types.Object.html

Class

Class

PUBLIC

Represents a JSON object.
fiftyone.operators.types.Object.root_view

fiftyone.operators.types.Object.html#root_view

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Object.__init__

fiftyone.operators.types.Object.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Object.properties

fiftyone.operators.types.Object.html#properties

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Object.add_property

fiftyone.operators.types.Object.html#add_property

Function

Method

PUBLIC

Adds a property to the object.
fiftyone.operators.types.Object.get_property

fiftyone.operators.types.Object.html#get_property

Function

Method

PUBLIC

Gets a property by name.
fiftyone.operators.types.Object.define_property

fiftyone.operators.types.Object.html#define_property

Function

Method

PUBLIC

Defines a property on the object.
fiftyone.operators.types.Object.str

fiftyone.operators.types.Object.html#str

Function

Method

PUBLIC

Defines a property on the object that is a string.
fiftyone.operators.types.Object.bool

fiftyone.operators.types.Object.html#bool

Function

Method

PUBLIC

Defines a property on the object that is a boolean.
fiftyone.operators.types.Object.int

fiftyone.operators.types.Object.html#int

Function

Method

PUBLIC

Defines a property on the object that is an integer.
fiftyone.operators.types.Object.float

fiftyone.operators.types.Object.html#float

Function

Method

PUBLIC

Defines a property on the object that is a float.
fiftyone.operators.types.Object.enum

fiftyone.operators.types.Object.html#enum

Function

Method

PUBLIC

Defines a property on the object that is an enum.
fiftyone.operators.types.Object.list

fiftyone.operators.types.Object.html#list

Function

Method

PUBLIC

Defines a property on the object that is a list.
fiftyone.operators.types.Object.obj

fiftyone.operators.types.Object.html#obj

Function

Method

PUBLIC

Defines a property on the object that is an object.
fiftyone.operators.types.Object.file

fiftyone.operators.types.Object.html#file

Function

Method

PUBLIC

Defines a property on the object that is a file.
fiftyone.operators.types.Object.uploaded_file

fiftyone.operators.types.Object.html#uploaded_file

Function

Method

PUBLIC

Defines a property on the object that is an uploaded file.
fiftyone.operators.types.Object.view

fiftyone.operators.types.Object.html#view

Function

Method

PUBLIC

Defines a view-only property.
fiftyone.operators.types.Object.btn

fiftyone.operators.types.Object.html#btn

Function

Method

PUBLIC

Defines a button or icon button to display to the user as a Button.
fiftyone.operators.types.Object.img

fiftyone.operators.types.Object.html#img

Function

Method

PUBLIC

Defines an image to display to the user as a ImageView.
fiftyone.operators.types.Object.message

fiftyone.operators.types.Object.html#message

Function

Method

PUBLIC

Defines a message to display to the user as a Notice.
fiftyone.operators.types.Object.grid

fiftyone.operators.types.Object.html#grid

Function

Method

PUBLIC

Defines a grid view as a View.
fiftyone.operators.types.Object.dashboard

fiftyone.operators.types.Object.html#dashboard

Function

Method

PUBLIC

Defines a dashboard view as a View.
fiftyone.operators.types.Object.plot

fiftyone.operators.types.Object.html#plot

Function

Method

PUBLIC

Defines an object property displayed as a plot.
fiftyone.operators.types.Object.h_stack

fiftyone.operators.types.Object.html#h_stack

Function

Method

PUBLIC

Defines a horizontal stack object.
fiftyone.operators.types.Object.v_stack

fiftyone.operators.types.Object.html#v_stack

Function

Method

PUBLIC

Defines a vertical stack object.
fiftyone.operators.types.Object.menu

fiftyone.operators.types.Object.html#menu

Function

Method

PUBLIC

Defined an Object property that is displayed as a menu.
fiftyone.operators.types.Object.btn_group

fiftyone.operators.types.Object.html#btn_group

Function

Method

PUBLIC

Defines a button group object.
fiftyone.operators.types.Object.md

fiftyone.operators.types.Object.html#md

Function

Method

PUBLIC

Defines a markdown object.
fiftyone.operators.types.Object.media_player

fiftyone.operators.types.Object.html#media_player

Function

Method

PUBLIC

Defines a media player object.
fiftyone.operators.types.Object.arrow_nav

fiftyone.operators.types.Object.html#arrow_nav

Function

Method

PUBLIC

Defines a floating navigation arrows as a ArrowNavView.
fiftyone.operators.types.Object.map

fiftyone.operators.types.Object.html#map

Function

Method

PUBLIC

Defines a map property on the object.
fiftyone.operators.types.Object.oneof

fiftyone.operators.types.Object.html#oneof

Function

Method

PUBLIC

Defines a one-of property on the object.
fiftyone.operators.types.Object.tuple

fiftyone.operators.types.Object.html#tuple

Function

Method

PUBLIC

Defines a tuple property on the object.
fiftyone.operators.types.Object.tree

fiftyone.operators.types.Object.html#tree

Function

Method

PUBLIC

Defines a tree property on the object.
fiftyone.operators.types.Object.clone

fiftyone.operators.types.Object.html#clone

Function

Method

PUBLIC

Clones the definition of the object.
fiftyone.operators.types.Object.view_target

fiftyone.operators.types.Object.html#view_target

Function

Method

PUBLIC

Defines a view target property.
fiftyone.operators.types.Object.to_json

fiftyone.operators.types.Object.html#to_json

Function

Method

PUBLIC

Converts the object definition to JSON.
fiftyone.operators.types.Property

fiftyone.operators.types.Property.html

Class

Class

PUBLIC

Represents a property on an fiftyone.operators.Operator.
fiftyone.operators.types.Property.invalid

fiftyone.operators.types.Property.html#invalid

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Property.default

fiftyone.operators.types.Property.html#default

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Property.required

fiftyone.operators.types.Property.html#required

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Property.error_message

fiftyone.operators.types.Property.html#error_message

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Property.view

fiftyone.operators.types.Property.html#view

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Property.__init__

fiftyone.operators.types.Property.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Property.type

fiftyone.operators.types.Property.html#type

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Property.choices

fiftyone.operators.types.Property.html#choices

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Property.on_change

fiftyone.operators.types.Property.html#on_change

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Property.to_json

fiftyone.operators.types.Property.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.String

fiftyone.operators.types.String.html

Class

Class

PUBLIC

Represents a string.
fiftyone.operators.types.String.allow_empty

fiftyone.operators.types.String.html#allow_empty

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.String.__init__

fiftyone.operators.types.String.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.String.to_json

fiftyone.operators.types.String.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Boolean

fiftyone.operators.types.Boolean.html

Class

Class

PUBLIC

Represents a boolean.
fiftyone.operators.types.Boolean.__init__

fiftyone.operators.types.Boolean.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Number

fiftyone.operators.types.Number.html

Class

Class

PUBLIC

Represents a number.
fiftyone.operators.types.Number.min

fiftyone.operators.types.Number.html#min

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Number.max

fiftyone.operators.types.Number.html#max

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Number.int

fiftyone.operators.types.Number.html#int

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Number.float

fiftyone.operators.types.Number.html#float

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Number.__init__

fiftyone.operators.types.Number.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Number.to_json

fiftyone.operators.types.Number.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.List

fiftyone.operators.types.List.html

Class

Class

PUBLIC

Represents a list.
fiftyone.operators.types.List.min_items

fiftyone.operators.types.List.html#min_items

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.List.max_items

fiftyone.operators.types.List.html#max_items

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.List.__init__

fiftyone.operators.types.List.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.List.element_type

fiftyone.operators.types.List.html#element_type

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.List.to_json

fiftyone.operators.types.List.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.SampleID

fiftyone.operators.types.SampleID.html

Class

Class

PUBLIC

Represents a fiftyone.core.samples.Sample ID.
fiftyone.operators.types.SampleID.__init__

fiftyone.operators.types.SampleID.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Enum

fiftyone.operators.types.Enum.html

Class

Class

PUBLIC

Represents an enum.
fiftyone.operators.types.Enum.__init__

fiftyone.operators.types.Enum.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Enum.values

fiftyone.operators.types.Enum.html#values

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Enum.to_json

fiftyone.operators.types.Enum.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.OneOf

fiftyone.operators.types.OneOf.html

Class

Class

PUBLIC

Represents a one-of type.
fiftyone.operators.types.OneOf.__init__

fiftyone.operators.types.OneOf.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.OneOf.types

fiftyone.operators.types.OneOf.html#types

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.OneOf.to_json

fiftyone.operators.types.OneOf.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Tuple

fiftyone.operators.types.Tuple.html

Class

Class

PUBLIC

Represents a tuple of types.
fiftyone.operators.types.Tuple.__init__

fiftyone.operators.types.Tuple.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Tuple.items

fiftyone.operators.types.Tuple.html#items

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Tuple.to_json

fiftyone.operators.types.Tuple.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Tree

fiftyone.operators.types.Tree.html

Class

Class

PUBLIC

Represents a tree selection type. Examples:
fiftyone.operators.types.Tree.__init__

fiftyone.operators.types.Tree.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Tree.items

fiftyone.operators.types.Tree.html#items

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Tree.to_json

fiftyone.operators.types.Tree.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Map

fiftyone.operators.types.Map.html

Class

Class

PUBLIC

Represents a map.
fiftyone.operators.types.Map.__init__

fiftyone.operators.types.Map.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Map.key_type

fiftyone.operators.types.Map.html#key_type

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Map.value_type

fiftyone.operators.types.Map.html#value_type

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Map.to_json

fiftyone.operators.types.Map.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.File

fiftyone.operators.types.File.html

Class

Class

PUBLIC

Represents a file and related metadata for use with FileExplorerView.
fiftyone.operators.types.File.__init__

fiftyone.operators.types.File.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.UploadedFile

fiftyone.operators.types.UploadedFile.html

Class

Class

PUBLIC

Represents an object with uploaded file content and its metadata in properties.
fiftyone.operators.types.UploadedFile.__init__

fiftyone.operators.types.UploadedFile.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types._convert_callables_to_operator_uris

fiftyone.operators.types.html#_convert_callables_to_operator_uris

Function

Function

PRIVATE

Undocumented
fiftyone.operators.types.View

fiftyone.operators.types.View.html

Class

Class

PUBLIC

Represents a view of a Property.
fiftyone.operators.types.View.label

fiftyone.operators.types.View.html#label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.View.description

fiftyone.operators.types.View.html#description

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.View.caption

fiftyone.operators.types.View.html#caption

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.View.space

fiftyone.operators.types.View.html#space

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.View.placeholder

fiftyone.operators.types.View.html#placeholder

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.View.read_only

fiftyone.operators.types.View.html#read_only

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.View.component

fiftyone.operators.types.View.html#component

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.View.componentsProps

fiftyone.operators.types.View.html#componentsProps

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.View.container

fiftyone.operators.types.View.html#container

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.View.__init__

fiftyone.operators.types.View.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.View._kwargs

fiftyone.operators.types.View.html#_kwargs

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.types.View.clone

fiftyone.operators.types.View.html#clone

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.View.kwargs_to_json

fiftyone.operators.types.View.html#kwargs_to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.View.to_json

fiftyone.operators.types.View.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.InferredView

fiftyone.operators.types.InferredView.html

Class

Class

PUBLIC

Represents a view of a Property that is inferred from the data.
fiftyone.operators.types.InferredView.__init__

fiftyone.operators.types.InferredView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Form

fiftyone.operators.types.Form.html

Class

Class

PUBLIC

A form view.
fiftyone.operators.types.Form.__init__

fiftyone.operators.types.Form.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Form.live

fiftyone.operators.types.Form.html#live

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Form.submit_button_label

fiftyone.operators.types.Form.html#submit_button_label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Form.cancel_button_label

fiftyone.operators.types.Form.html#cancel_button_label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Form.to_json

fiftyone.operators.types.Form.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ReadOnlyView

fiftyone.operators.types.ReadOnlyView.html

Class

Class

PUBLIC

A read-only View.
fiftyone.operators.types.ReadOnlyView.__init__

fiftyone.operators.types.ReadOnlyView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ReadOnlyView.read_only

fiftyone.operators.types.ReadOnlyView.html#read_only

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Choice

fiftyone.operators.types.Choice.html

Class

Class

PUBLIC

Represents a choice in a Choices view.
fiftyone.operators.types.Choice.__init__

fiftyone.operators.types.Choice.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Choice.value

fiftyone.operators.types.Choice.html#value

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Choice.include

fiftyone.operators.types.Choice.html#include

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Choice.clone

fiftyone.operators.types.Choice.html#clone

Function

Method

PUBLIC

Clones the Choice.
fiftyone.operators.types.Choice.to_json

fiftyone.operators.types.Choice.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Choices

fiftyone.operators.types.Choices.html

Class

Class

PUBLIC

Represents a set of choices in a View.
fiftyone.operators.types.Choices.__init__

fiftyone.operators.types.Choices.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Choices._choices

fiftyone.operators.types.Choices.html#_choices

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.types.Choices.choices

fiftyone.operators.types.Choices.html#choices

Attribute

Property

PUBLIC

Undocumented
fiftyone.operators.types.Choices.values

fiftyone.operators.types.Choices.html#values

Function

Method

PUBLIC

Returns the choice values for this instance.
fiftyone.operators.types.Choices.add_choice

fiftyone.operators.types.Choices.html#add_choice

Function

Method

PUBLIC

Adds a choice value to this instance.
fiftyone.operators.types.Choices.append

fiftyone.operators.types.Choices.html#append

Function

Method

PUBLIC

Appends a Choice to the list of choices.
fiftyone.operators.types.Choices.clone

fiftyone.operators.types.Choices.html#clone

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Choices.to_json

fiftyone.operators.types.Choices.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.RadioGroup

fiftyone.operators.types.RadioGroup.html

Class

Class

PUBLIC

Represents a set of choices in a View that are displayed as a radio group.
fiftyone.operators.types.RadioGroup.orientation

fiftyone.operators.types.RadioGroup.html#orientation

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.RadioGroup.__init__

fiftyone.operators.types.RadioGroup.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.RadioGroup.to_json

fiftyone.operators.types.RadioGroup.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Dropdown

fiftyone.operators.types.Dropdown.html

Class

Class

PUBLIC

Represents a set of choices in a View that are displayed as a dropdown.
fiftyone.operators.types.Dropdown.__init__

fiftyone.operators.types.Dropdown.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Notice

fiftyone.operators.types.Notice.html

Class

Class

PUBLIC

Represents a notice in a View.
fiftyone.operators.types.Notice.__init__

fiftyone.operators.types.Notice.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Header

fiftyone.operators.types.Header.html

Class

Class

PUBLIC

Represents a header in a View.
fiftyone.operators.types.Header.__init__

fiftyone.operators.types.Header.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Warning

fiftyone.operators.types.Warning.html

Class

Class

PUBLIC

Represents a warning in a View.
fiftyone.operators.types.Warning.__init__

fiftyone.operators.types.Warning.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Error

fiftyone.operators.types.Error.html

Class

Class

PUBLIC

Represents an error in a View.
fiftyone.operators.types.Error.__init__

fiftyone.operators.types.Error.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Button

fiftyone.operators.types.Button.html

Class

Class

PUBLIC

Represents a button in a View.
fiftyone.operators.types.Button.operator

fiftyone.operators.types.Button.html#operator

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Button.params

fiftyone.operators.types.Button.html#params

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Button.href

fiftyone.operators.types.Button.html#href

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Button.__init__

fiftyone.operators.types.Button.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Button.prompt

fiftyone.operators.types.Button.html#prompt

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Button.to_json

fiftyone.operators.types.Button.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.OperatorExecutionButtonView

fiftyone.operators.types.OperatorExecutionButtonView.html

Class

Class

PUBLIC

Represents an operator execution button in a View.
fiftyone.operators.types.OperatorExecutionButtonView.__init__

fiftyone.operators.types.OperatorExecutionButtonView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.OneOfView

fiftyone.operators.types.OneOfView.html

Class

Class

PUBLIC

Displays one of the given View instances.
fiftyone.operators.types.OneOfView.oneof

fiftyone.operators.types.OneOfView.html#oneof

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.OneOfView.__init__

fiftyone.operators.types.OneOfView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.OneOfView.to_json

fiftyone.operators.types.OneOfView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ListView

fiftyone.operators.types.ListView.html

Class

Class

PUBLIC

Displays a list of View instances.
fiftyone.operators.types.ListView.__init__

fiftyone.operators.types.ListView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ListView.items

fiftyone.operators.types.ListView.html#items

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.ListView.to_json

fiftyone.operators.types.ListView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TupleView

fiftyone.operators.types.TupleView.html

Class

Class

PUBLIC

Displays a tuple of View instances.
fiftyone.operators.types.TupleView.__init__

fiftyone.operators.types.TupleView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TupleView.items

fiftyone.operators.types.TupleView.html#items

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.TupleView.to_json

fiftyone.operators.types.TupleView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TreeSelectionView

fiftyone.operators.types.TreeSelectionView.html

Class

Class

PUBLIC

Displays a tree selection checkbox groups.
fiftyone.operators.types.TreeSelectionView.__init__

fiftyone.operators.types.TreeSelectionView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TreeSelectionView.to_json

fiftyone.operators.types.TreeSelectionView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.CodeView

fiftyone.operators.types.CodeView.html

Class

Class

PUBLIC

Displays a code editor.
fiftyone.operators.types.CodeView.language

fiftyone.operators.types.CodeView.html#language

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.CodeView.__init__

fiftyone.operators.types.CodeView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.CodeView.to_json

fiftyone.operators.types.CodeView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ColorView

fiftyone.operators.types.ColorView.html

Class

Class

PUBLIC

Displays a color picker.
fiftyone.operators.types.ColorView.compact

fiftyone.operators.types.ColorView.html#compact

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.ColorView.variant

fiftyone.operators.types.ColorView.html#variant

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.ColorView.__init__

fiftyone.operators.types.ColorView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ColorView.to_json

fiftyone.operators.types.ColorView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TabsView

fiftyone.operators.types.TabsView.html

Class

Class

PUBLIC

Displays a tabbed view.
fiftyone.operators.types.TabsView.variant

fiftyone.operators.types.TabsView.html#variant

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.TabsView.__init__

fiftyone.operators.types.TabsView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TabsView.to_json

fiftyone.operators.types.TabsView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.JSONView

fiftyone.operators.types.JSONView.html

Class

Class

PUBLIC

Displays a JSON viewer.
fiftyone.operators.types.JSONView.__init__

fiftyone.operators.types.JSONView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.AutocompleteView

fiftyone.operators.types.AutocompleteView.html

Class

Class

PUBLIC

Displays an autocomplete input.
fiftyone.operators.types.AutocompleteView.__init__

fiftyone.operators.types.AutocompleteView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.FileView

fiftyone.operators.types.FileView.html

Class

Class

PUBLIC

Displays a file input.
fiftyone.operators.types.FileView.__init__

fiftyone.operators.types.FileView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.LinkView

fiftyone.operators.types.LinkView.html

Class

Class

PUBLIC

Displays a hyperlink.
fiftyone.operators.types.LinkView.href

fiftyone.operators.types.LinkView.html#href

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.LinkView.__init__

fiftyone.operators.types.LinkView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.LinkView.to_json

fiftyone.operators.types.LinkView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.HiddenView

fiftyone.operators.types.HiddenView.html

Class

Class

PUBLIC

Allows properties to be hidden from the user.
fiftyone.operators.types.HiddenView.__init__

fiftyone.operators.types.HiddenView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.LoadingView

fiftyone.operators.types.LoadingView.html

Class

Class

PUBLIC

Displays a loading indicator.
fiftyone.operators.types.LoadingView.__init__

fiftyone.operators.types.LoadingView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.PillBadgeView

fiftyone.operators.types.PillBadgeView.html

Class

Class

PUBLIC

Displays a pill shaped badge.
fiftyone.operators.types.PillBadgeView.__init__

fiftyone.operators.types.PillBadgeView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.PlotlyView

fiftyone.operators.types.PlotlyView.html

Class

Class

PUBLIC

Displays a Plotly chart.
fiftyone.operators.types.PlotlyView.data

fiftyone.operators.types.PlotlyView.html#data

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.PlotlyView.config

fiftyone.operators.types.PlotlyView.html#config

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.PlotlyView.layout

fiftyone.operators.types.PlotlyView.html#layout

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.PlotlyView.__init__

fiftyone.operators.types.PlotlyView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.PlotlyView.to_json

fiftyone.operators.types.PlotlyView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Placement

fiftyone.operators.types.Placement.html

Class

Class

PUBLIC

Represents the placement of an operator in the FiftyOne App.
fiftyone.operators.types.Placement.view

fiftyone.operators.types.Placement.html#view

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Placement.__init__

fiftyone.operators.types.Placement.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Placement.place

fiftyone.operators.types.Placement.html#place

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Placement.to_json

fiftyone.operators.types.Placement.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Places

fiftyone.operators.types.Places.html

Class

Class

PUBLIC

The places available to operators in the FiftyOne App.
fiftyone.operators.types.Places.SAMPLES_GRID_ACTIONS

fiftyone.operators.types.Places.html#SAMPLES_GRID_ACTIONS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.types.Places.SAMPLES_GRID_SECONDARY_ACTIONS

fiftyone.operators.types.Places.html#SAMPLES_GRID_SECONDARY_ACTIONS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.types.Places.SAMPLES_VIEWER_ACTIONS

fiftyone.operators.types.Places.html#SAMPLES_VIEWER_ACTIONS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.types.Places.EMBEDDINGS_ACTIONS

fiftyone.operators.types.Places.html#EMBEDDINGS_ACTIONS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.types.Places.HISTOGRAM_ACTIONS

fiftyone.operators.types.Places.html#HISTOGRAM_ACTIONS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.types.Places.MAP_ACTIONS

fiftyone.operators.types.Places.html#MAP_ACTIONS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.types.Places.MAP_SECONDARY_ACTIONS

fiftyone.operators.types.Places.html#MAP_SECONDARY_ACTIONS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.types.Places.DISPLAY_OPTIONS

fiftyone.operators.types.Places.html#DISPLAY_OPTIONS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.types.Places.to_json

fiftyone.operators.types.Places.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.KeyValueView

fiftyone.operators.types.KeyValueView.html

Class

Class

PUBLIC

Displays a key-value editor.
fiftyone.operators.types.KeyValueView.__init__

fiftyone.operators.types.KeyValueView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Column

fiftyone.operators.types.Column.html

Class

Class

PUBLIC

A column in a TableView.
fiftyone.operators.types.Column.__init__

fiftyone.operators.types.Column.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Column.key

fiftyone.operators.types.Column.html#key

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Column.clone

fiftyone.operators.types.Column.html#clone

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Column.to_json

fiftyone.operators.types.Column.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Action

fiftyone.operators.types.Action.html

Class

Class

PUBLIC

An action (currently supported only in a TableView).
fiftyone.operators.types.Action.__init__

fiftyone.operators.types.Action.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Action.name

fiftyone.operators.types.Action.html#name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Action.clone

fiftyone.operators.types.Action.html#clone

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Action.to_json

fiftyone.operators.types.Action.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Tooltip

fiftyone.operators.types.Tooltip.html

Class

Class

PUBLIC

A tooltip (currently supported only in a TableView).
fiftyone.operators.types.Tooltip.__init__

fiftyone.operators.types.Tooltip.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Tooltip.row

fiftyone.operators.types.Tooltip.html#row

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Tooltip.column

fiftyone.operators.types.Tooltip.html#column

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.Tooltip.clone

fiftyone.operators.types.Tooltip.html#clone

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Tooltip.to_json

fiftyone.operators.types.Tooltip.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TableView

fiftyone.operators.types.TableView.html

Class

Class

PUBLIC

Displays a table.
fiftyone.operators.types.TableView.columns

fiftyone.operators.types.TableView.html#columns

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.TableView.row_actions

fiftyone.operators.types.TableView.html#row_actions

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.TableView.__init__

fiftyone.operators.types.TableView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TableView.tooltips

fiftyone.operators.types.TableView.html#tooltips

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.TableView._tooltip_map

fiftyone.operators.types.TableView.html#_tooltip_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.types.TableView.keys

fiftyone.operators.types.TableView.html#keys

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TableView.add_column

fiftyone.operators.types.TableView.html#add_column

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TableView.add_row_action

fiftyone.operators.types.TableView.html#add_row_action

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TableView.add_tooltip

fiftyone.operators.types.TableView.html#add_tooltip

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TableView.clone

fiftyone.operators.types.TableView.html#clone

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TableView.to_json

fiftyone.operators.types.TableView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.MapView

fiftyone.operators.types.MapView.html

Class

Class

PUBLIC

Displays a key-value mapping.
fiftyone.operators.types.MapView.__init__

fiftyone.operators.types.MapView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.MapView.key

fiftyone.operators.types.MapView.html#key

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.MapView.value

fiftyone.operators.types.MapView.html#value

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.MapView.to_json

fiftyone.operators.types.MapView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ProgressView

fiftyone.operators.types.ProgressView.html

Class

Class

PUBLIC

Displays a progress bar.
fiftyone.operators.types.ProgressView.variant

fiftyone.operators.types.ProgressView.html#variant

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.ProgressView.__init__

fiftyone.operators.types.ProgressView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ProgressView.to_json

fiftyone.operators.types.ProgressView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ImageView

fiftyone.operators.types.ImageView.html

Class

Class

PUBLIC

Displays an image.
fiftyone.operators.types.ImageView.__init__

fiftyone.operators.types.ImageView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.AlertView

fiftyone.operators.types.AlertView.html

Class

Class

PUBLIC

Displays an alert.
fiftyone.operators.types.AlertView.severity

fiftyone.operators.types.AlertView.html#severity

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.AlertView.__init__

fiftyone.operators.types.AlertView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.AlertView.to_json

fiftyone.operators.types.AlertView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ToastView

fiftyone.operators.types.ToastView.html

Class

Class

PUBLIC

Displays a snackbar style toast element.
fiftyone.operators.types.ToastView.__init__

fiftyone.operators.types.ToastView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.CheckboxView

fiftyone.operators.types.CheckboxView.html

Class

Class

PUBLIC

Displays a checkbox.
fiftyone.operators.types.CheckboxView.__init__

fiftyone.operators.types.CheckboxView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ErrorView

fiftyone.operators.types.ErrorView.html

Class

Class

PUBLIC

Displays an error.
fiftyone.operators.types.ErrorView.__init__

fiftyone.operators.types.ErrorView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.HeaderView

fiftyone.operators.types.HeaderView.html

Class

Class

PUBLIC

Displays a header component.
fiftyone.operators.types.HeaderView.__init__

fiftyone.operators.types.HeaderView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ObjectView

fiftyone.operators.types.ObjectView.html

Class

Class

PUBLIC

Displays an object component.
fiftyone.operators.types.ObjectView.__init__

fiftyone.operators.types.ObjectView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.RadioView

fiftyone.operators.types.RadioView.html

Class

Class

PUBLIC

Displays a radio component for the given RadioGroup instance.
fiftyone.operators.types.RadioView.__init__

fiftyone.operators.types.RadioView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.SwitchView

fiftyone.operators.types.SwitchView.html

Class

Class

PUBLIC

Displays a toggle switch.
fiftyone.operators.types.SwitchView.__init__

fiftyone.operators.types.SwitchView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TextView

fiftyone.operators.types.TextView.html

Class

Class

PUBLIC

Displays a text. .. note:
fiftyone.operators.types.TextView.__init__

fiftyone.operators.types.TextView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TextFieldView

fiftyone.operators.types.TextFieldView.html

Class

Class

PUBLIC

Displays a text input.
fiftyone.operators.types.TextFieldView.__init__

fiftyone.operators.types.TextFieldView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.FieldView

fiftyone.operators.types.FieldView.html

Class

Class

PUBLIC

Displays a text input.
fiftyone.operators.types.FieldView.__init__

fiftyone.operators.types.FieldView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.LazyFieldView

fiftyone.operators.types.LazyFieldView.html

Class

Class

PUBLIC

Displays a lazy text input which only apply input field changes on blur or when user clicks the save button within the field.
fiftyone.operators.types.LazyFieldView.save_on_blur

fiftyone.operators.types.LazyFieldView.html#save_on_blur

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.LazyFieldView.__init__

fiftyone.operators.types.LazyFieldView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.LazyFieldView.to_json

fiftyone.operators.types.LazyFieldView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.DropdownView

fiftyone.operators.types.DropdownView.html

Class

Class

PUBLIC

Displays a dropdown selector input.
fiftyone.operators.types.DropdownView.__init__

fiftyone.operators.types.DropdownView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.LabelValueView

fiftyone.operators.types.LabelValueView.html

Class

Class

PUBLIC

Displays a label-value component. Used for displaying a label and a corresponding value.
fiftyone.operators.types.LabelValueView.__init__

fiftyone.operators.types.LabelValueView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.PrimitiveView

fiftyone.operators.types.PrimitiveView.html

Class

Class

PUBLIC

Displays a primitive value component.
fiftyone.operators.types.PrimitiveView.__init__

fiftyone.operators.types.PrimitiveView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.SliderView

fiftyone.operators.types.SliderView.html

Class

Class

PUBLIC

Displays a slider component.
fiftyone.operators.types.SliderView.__init__

fiftyone.operators.types.SliderView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TagsView

fiftyone.operators.types.TagsView.html

Class

Class

PUBLIC

Displays a list of tags component.
fiftyone.operators.types.TagsView.__init__

fiftyone.operators.types.TagsView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Success

fiftyone.operators.types.Success.html

Class

Class

PUBLIC

Represents a success in a View.
fiftyone.operators.types.Success.__init__

fiftyone.operators.types.Success.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ButtonView

fiftyone.operators.types.ButtonView.html

Class

Class

PUBLIC

Represents a button in a Button.
fiftyone.operators.types.ButtonView.__init__

fiftyone.operators.types.ButtonView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.MarkdownView

fiftyone.operators.types.MarkdownView.html

Class

Class

PUBLIC

Renders a markdown string as HTML.
fiftyone.operators.types.MarkdownView.__init__

fiftyone.operators.types.MarkdownView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.StatusButtonView

fiftyone.operators.types.StatusButtonView.html

Class

Class

PUBLIC

Renders a status button.
fiftyone.operators.types.StatusButtonView.__init__

fiftyone.operators.types.StatusButtonView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.MediaPlayerView

fiftyone.operators.types.MediaPlayerView.html

Class

Class

PUBLIC

Renders a media player for audio and video files.
fiftyone.operators.types.MediaPlayerView.__init__

fiftyone.operators.types.MediaPlayerView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.FileExplorerView

fiftyone.operators.types.FileExplorerView.html

Class

Class

PUBLIC

Displays a file explorer for interacting with files.
fiftyone.operators.types.FileExplorerView.__init__

fiftyone.operators.types.FileExplorerView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.PromptView

fiftyone.operators.types.PromptView.html

Class

Class

PUBLIC

Customizes how a prompt is rendered.
fiftyone.operators.types.PromptView.__init__

fiftyone.operators.types.PromptView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ViewTargetOptions

fiftyone.operators.types.ViewTargetOptions.html

Class

Class

PUBLIC

Represents the options for a ViewTargetProperty.
fiftyone.operators.types.ViewTargetOptions.entire_dataset

fiftyone.operators.types.ViewTargetOptions.html#entire_dataset

Attribute

Instance Variable

PUBLIC

a Choice for the entire dataset
fiftyone.operators.types.ViewTargetOptions.current_view

fiftyone.operators.types.ViewTargetOptions.html#current_view

Attribute

Instance Variable

PUBLIC

a Choice for the current view
fiftyone.operators.types.ViewTargetOptions.selected_samples

fiftyone.operators.types.ViewTargetOptions.html#selected_samples

Attribute

Instance Variable

PUBLIC

a Choice for the selected samples
fiftyone.operators.types.ViewTargetOptions.__init__

fiftyone.operators.types.ViewTargetOptions.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ViewTargetOptions.choices_view

fiftyone.operators.types.ViewTargetOptions.html#choices_view

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.ViewTargetOptions.values

fiftyone.operators.types.ViewTargetOptions.html#values

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ViewTargetProperty

fiftyone.operators.types.ViewTargetProperty.html

Class

Class

PUBLIC

Displays a view target selector.
fiftyone.operators.types.ViewTargetProperty.__init__

fiftyone.operators.types.ViewTargetProperty.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ViewTargetProperty._options

fiftyone.operators.types.ViewTargetProperty.html#_options

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.types.ViewTargetProperty.options 0

fiftyone.operators.types.ViewTargetProperty.html#options%200

Attribute

Instance Variable

PUBLIC

a ViewTargetOptions instance
fiftyone.operators.types.ViewTargetProperty.options

fiftyone.operators.types.ViewTargetProperty.html#options

Attribute

Property

PUBLIC

Undocumented
fiftyone.operators.types.GridView

fiftyone.operators.types.GridView.html

Class

Class

PUBLIC

Displays properties of an object as a grid of components in horizontal or vertical orientation.
fiftyone.operators.types.GridView.orientation

fiftyone.operators.types.GridView.html#orientation

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.GridView.gap

fiftyone.operators.types.GridView.html#gap

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.GridView.align_x

fiftyone.operators.types.GridView.html#align_x

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.GridView.align_y

fiftyone.operators.types.GridView.html#align_y

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.GridView.__init__

fiftyone.operators.types.GridView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.GridView.container

fiftyone.operators.types.GridView.html#container

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.GridView.to_json

fiftyone.operators.types.GridView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.DashboardView

fiftyone.operators.types.DashboardView.html

Class

Class

PUBLIC

Defines a Dashboard view.
fiftyone.operators.types.DashboardView.allow_addition

fiftyone.operators.types.DashboardView.html#allow_addition

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.DashboardView.allow_deletion

fiftyone.operators.types.DashboardView.html#allow_deletion

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.DashboardView.allow_edit

fiftyone.operators.types.DashboardView.html#allow_edit

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.DashboardView.cta_title

fiftyone.operators.types.DashboardView.html#cta_title

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.DashboardView.cta_body

fiftyone.operators.types.DashboardView.html#cta_body

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.DashboardView.cta_button_label

fiftyone.operators.types.DashboardView.html#cta_button_label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.DashboardView.rows

fiftyone.operators.types.DashboardView.html#rows

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.DashboardView.cols

fiftyone.operators.types.DashboardView.html#cols

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.DashboardView.items

fiftyone.operators.types.DashboardView.html#items

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.DashboardView.auto_layout

fiftyone.operators.types.DashboardView.html#auto_layout

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.DashboardView.__init__

fiftyone.operators.types.DashboardView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.DashboardView.to_json

fiftyone.operators.types.DashboardView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.DrawerView

fiftyone.operators.types.DrawerView.html

Class

Class

PUBLIC

Renders an operator prompt as a left or right side drawer.
fiftyone.operators.types.DrawerView.__init__

fiftyone.operators.types.DrawerView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.IconButtonView

fiftyone.operators.types.IconButtonView.html

Class

Class

PUBLIC

Represents a button in a View.
fiftyone.operators.types.IconButtonView.__init__

fiftyone.operators.types.IconButtonView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ModalView

fiftyone.operators.types.ModalView.html

Class

Class

PUBLIC

Represents a button in a View that opens up an interactive modal.
fiftyone.operators.types.ModalView.__init__

fiftyone.operators.types.ModalView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.HStackView

fiftyone.operators.types.HStackView.html

Class

Class

PUBLIC

Displays properties of an object as a horizontal stack of components.
fiftyone.operators.types.HStackView.__init__

fiftyone.operators.types.HStackView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.VStackView

fiftyone.operators.types.VStackView.html

Class

Class

PUBLIC

Displays properties of an object as a vertical stack of components.
fiftyone.operators.types.VStackView.__init__

fiftyone.operators.types.VStackView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.VStackView.to_json

fiftyone.operators.types.VStackView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ButtonGroupView

fiftyone.operators.types.ButtonGroupView.html

Class

Class

PUBLIC

Displays a group of buttons in a horizontal stack.
fiftyone.operators.types.ButtonGroupView.__init__

fiftyone.operators.types.ButtonGroupView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ButtonGroupView.to_json

fiftyone.operators.types.ButtonGroupView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.MenuView

fiftyone.operators.types.MenuView.html

Class

Class

PUBLIC

Displays a menu of options in a vertical stack.
fiftyone.operators.types.MenuView.__init__

fiftyone.operators.types.MenuView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.MenuView.to_json

fiftyone.operators.types.MenuView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ArrowNavView

fiftyone.operators.types.ArrowNavView.html

Class

Class

PUBLIC

Displays a floating navigation arrows.
fiftyone.operators.types.ArrowNavView.forward

fiftyone.operators.types.ArrowNavView.html#forward

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.ArrowNavView.backward

fiftyone.operators.types.ArrowNavView.html#backward

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.ArrowNavView.position

fiftyone.operators.types.ArrowNavView.html#position

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.ArrowNavView.__init__

fiftyone.operators.types.ArrowNavView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.ArrowNavView.to_json

fiftyone.operators.types.ArrowNavView.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.FrameLoaderView

fiftyone.operators.types.FrameLoaderView.html

Class

Class

PUBLIC

Utility for animating panel state based on the given timeline_name.
fiftyone.operators.types.FrameLoaderView.__init__

fiftyone.operators.types.FrameLoaderView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TimelineView

fiftyone.operators.types.TimelineView.html

Class

Class

PUBLIC

Represents a timeline for playing animations.
fiftyone.operators.types.TimelineView.__init__

fiftyone.operators.types.TimelineView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.TimerView

fiftyone.operators.types.TimerView.html

Class

Class

PUBLIC

Supports a timer for executing operators/events after a specified duration or interval.
fiftyone.operators.types.TimerView.__init__

fiftyone.operators.types.TimerView.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Container

fiftyone.operators.types.Container.html

Class

Class

PUBLIC

Represents a base container for a container types.
fiftyone.operators.types.Container.__init__

fiftyone.operators.types.Container.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Container._kwargs

fiftyone.operators.types.Container.html#_kwargs

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.types.Container.kwargs_to_json

fiftyone.operators.types.Container.html#kwargs_to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.Container.to_json

fiftyone.operators.types.Container.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.PaperContainer

fiftyone.operators.types.PaperContainer.html

Class

Class

PUBLIC

Represents an elevated block for a view.
fiftyone.operators.types.PaperContainer.elevation

fiftyone.operators.types.PaperContainer.html#elevation

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.PaperContainer.rounded

fiftyone.operators.types.PaperContainer.html#rounded

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.PaperContainer.__init__

fiftyone.operators.types.PaperContainer.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.PaperContainer.to_json

fiftyone.operators.types.PaperContainer.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.OutlinedContainer

fiftyone.operators.types.OutlinedContainer.html

Class

Class

PUBLIC

Represents an elevated block for a view.
fiftyone.operators.types.OutlinedContainer.rounded

fiftyone.operators.types.OutlinedContainer.html#rounded

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.types.OutlinedContainer.__init__

fiftyone.operators.types.OutlinedContainer.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.types.OutlinedContainer.to_json

fiftyone.operators.types.OutlinedContainer.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.operator.BUILTIN_OPERATOR_PREFIX

fiftyone.operators.operator.html#BUILTIN_OPERATOR_PREFIX

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig

fiftyone.operators.operator.OperatorConfig.html

Class

Class

PUBLIC

A configuration for an operator.
fiftyone.operators.operator.OperatorConfig.label

fiftyone.operators.operator.OperatorConfig.html#label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.description

fiftyone.operators.operator.OperatorConfig.html#description

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.dynamic

fiftyone.operators.operator.OperatorConfig.html#dynamic

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.execute_as_generator

fiftyone.operators.operator.OperatorConfig.html#execute_as_generator

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.unlisted

fiftyone.operators.operator.OperatorConfig.html#unlisted

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.on_startup

fiftyone.operators.operator.OperatorConfig.html#on_startup

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.on_dataset_open

fiftyone.operators.operator.OperatorConfig.html#on_dataset_open

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.disable_schema_validation

fiftyone.operators.operator.OperatorConfig.html#disable_schema_validation

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.icon

fiftyone.operators.operator.OperatorConfig.html#icon

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.light_icon

fiftyone.operators.operator.OperatorConfig.html#light_icon

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.dark_icon

fiftyone.operators.operator.OperatorConfig.html#dark_icon

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.allow_immediate_execution

fiftyone.operators.operator.OperatorConfig.html#allow_immediate_execution

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.allow_delegated_execution

fiftyone.operators.operator.OperatorConfig.html#allow_delegated_execution

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.default_choice_to_delegated

fiftyone.operators.operator.OperatorConfig.html#default_choice_to_delegated

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.resolve_execution_options_on_change

fiftyone.operators.operator.OperatorConfig.html#resolve_execution_options_on_change

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.__init__

fiftyone.operators.operator.OperatorConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.name

fiftyone.operators.operator.OperatorConfig.html#name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.delegation_target

fiftyone.operators.operator.OperatorConfig.html#delegation_target

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.kwargs

fiftyone.operators.operator.OperatorConfig.html#kwargs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.OperatorConfig.to_json

fiftyone.operators.operator.OperatorConfig.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.operator.Operator

fiftyone.operators.operator.Operator.html

Class

Class

PUBLIC

A FiftyOne operator.
fiftyone.operators.operator.Operator.__init__

fiftyone.operators.operator.Operator.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.operator.Operator._builtin

fiftyone.operators.operator.Operator.html#_builtin

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.operator.Operator._plugin_secrets

fiftyone.operators.operator.Operator.html#_plugin_secrets

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.operator.Operator.plugin_name

fiftyone.operators.operator.Operator.html#plugin_name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.operator.Operator.name

fiftyone.operators.operator.Operator.html#name

Attribute

Property

PUBLIC

Undocumented
fiftyone.operators.operator.Operator.uri

fiftyone.operators.operator.Operator.html#uri

Attribute

Property

PUBLIC

The unique identifier of the operator: plugin_name/operator_name.
fiftyone.operators.operator.Operator.builtin

fiftyone.operators.operator.Operator.html#builtin

Attribute

Property

PUBLIC

Whether the operator is builtin.
fiftyone.operators.operator.Operator.config

fiftyone.operators.operator.Operator.html#config

Attribute

Property

PUBLIC

The OperatorConfig for the operator.
fiftyone.operators.operator.Operator.resolve_delegation

fiftyone.operators.operator.Operator.html#resolve_delegation

Function

Method

PUBLIC

Returns the resolved forced delegation flag.
fiftyone.operators.operator.Operator.resolve_execution_options

fiftyone.operators.operator.Operator.html#resolve_execution_options

Function

Method

PUBLIC

Returns the resolved execution options.
fiftyone.operators.operator.Operator.execute

fiftyone.operators.operator.Operator.html#execute

Function

Method

PUBLIC

Executes the operator.
fiftyone.operators.operator.Operator.resolve_type

fiftyone.operators.operator.Operator.html#resolve_type

Function

Method

PUBLIC

Returns the resolved input or output property.
fiftyone.operators.operator.Operator.resolve_input

fiftyone.operators.operator.Operator.html#resolve_input

Function

Method

PUBLIC

Returns the resolved input property.
fiftyone.operators.operator.Operator.resolve_output

fiftyone.operators.operator.Operator.html#resolve_output

Function

Method

PUBLIC

Returns the resolved output property.
fiftyone.operators.operator.Operator.resolve_placement

fiftyone.operators.operator.Operator.html#resolve_placement

Function

Method

PUBLIC

Returns the resolved placement of the operator.
fiftyone.operators.operator.Operator.method_to_uri

fiftyone.operators.operator.Operator.html#method_to_uri

Function

Method

PUBLIC

Converts a method name to a URI.
fiftyone.operators.operator.Operator.to_json

fiftyone.operators.operator.Operator.html#to_json

Function

Method

PUBLIC

Returns a JSON representation of the operator.
fiftyone.operators.operator.Operator.add_secrets

fiftyone.operators.operator.Operator.html#add_secrets

Function

Method

PUBLIC

Adds secrets to the operator.
fiftyone.operators.panel.PANEL_SURFACE

fiftyone.operators.panel.html#PANEL_SURFACE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig

fiftyone.operators.panel.PanelConfig.html

Class

Class

PUBLIC

Configuration for a panel.
fiftyone.operators.panel.PanelConfig.icon

fiftyone.operators.panel.PanelConfig.html#icon

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig.light_icon

fiftyone.operators.panel.PanelConfig.html#light_icon

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig.dark_icon

fiftyone.operators.panel.PanelConfig.html#dark_icon

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig.allow_multiple

fiftyone.operators.panel.PanelConfig.html#allow_multiple

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig.surfaces

fiftyone.operators.panel.PanelConfig.html#surfaces

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig.help_markdown

fiftyone.operators.panel.PanelConfig.html#help_markdown

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig.category

fiftyone.operators.panel.PanelConfig.html#category

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig.priority

fiftyone.operators.panel.PanelConfig.html#priority

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig.__init__

fiftyone.operators.panel.PanelConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig.name

fiftyone.operators.panel.PanelConfig.html#name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig.label

fiftyone.operators.panel.PanelConfig.html#label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig.unlisted

fiftyone.operators.panel.PanelConfig.html#unlisted

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig.on_startup

fiftyone.operators.panel.PanelConfig.html#on_startup

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig.beta

fiftyone.operators.panel.PanelConfig.html#beta

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig.is_new

fiftyone.operators.panel.PanelConfig.html#is_new

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig.kwargs

fiftyone.operators.panel.PanelConfig.html#kwargs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.panel.PanelConfig.to_json

fiftyone.operators.panel.PanelConfig.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.panel.Panel

fiftyone.operators.panel.Panel.html

Class

Class

PUBLIC

A panel.
fiftyone.operators.panel.Panel.render

fiftyone.operators.panel.Panel.html#render

Function

Method

PUBLIC

Defines the panel's layout and events.
fiftyone.operators.panel.Panel.resolve_input

fiftyone.operators.panel.Panel.html#resolve_input

Function

Method

PUBLIC

Returns the resolved input property.
fiftyone.operators.panel.Panel.on_startup

fiftyone.operators.panel.Panel.html#on_startup

Function

Method

PUBLIC

Undocumented
fiftyone.operators.panel.Panel.on_load

fiftyone.operators.panel.Panel.html#on_load

Function

Method

PUBLIC

Undocumented
fiftyone.operators.panel.Panel.execute

fiftyone.operators.panel.Panel.html#execute

Function

Method

PUBLIC

Executes the operator.
fiftyone.operators.panel.WriteOnlyError

fiftyone.operators.panel.WriteOnlyError.html

Class

Exception

PUBLIC

Error raised when trying to read a write-only property.
fiftyone.operators.panel.PanelRefBase

fiftyone.operators.panel.PanelRefBase.html

Class

Class

PUBLIC

Base class for panel state and data.
fiftyone.operators.panel.PanelRefBase.__init__

fiftyone.operators.panel.PanelRefBase.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.panel.PanelRefBase._data

fiftyone.operators.panel.PanelRefBase.html#_data

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.panel.PanelRefBase._ctx

fiftyone.operators.panel.PanelRefBase.html#_ctx

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.panel.PanelRefBase.set

fiftyone.operators.panel.PanelRefBase.html#set

Function

Method

PUBLIC

Sets some value(s) in the dictionary.
fiftyone.operators.panel.PanelRefBase.get

fiftyone.operators.panel.PanelRefBase.html#get

Function

Method

PUBLIC

Gets a value from the dictionary.
fiftyone.operators.panel.PanelRefBase.clear

fiftyone.operators.panel.PanelRefBase.html#clear

Function

Method

PUBLIC

Clears the dictionary.
fiftyone.operators.panel.PanelRefBase.__setattr__

fiftyone.operators.panel.PanelRefBase.html#__setattr__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.panel.PanelRefBase.__getattr__

fiftyone.operators.panel.PanelRefBase.html#__getattr__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.panel.PanelRefState

fiftyone.operators.panel.PanelRefState.html

Class

Class

PUBLIC

Class representing the state of a panel.
fiftyone.operators.panel.PanelRefState.__init__

fiftyone.operators.panel.PanelRefState.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.panel.PanelRefState._data

fiftyone.operators.panel.PanelRefState.html#_data

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.panel.PanelRefState.set

fiftyone.operators.panel.PanelRefState.html#set

Function

Method

PUBLIC

Sets some panel state.
fiftyone.operators.panel.PanelRefState.clear

fiftyone.operators.panel.PanelRefState.html#clear

Function

Method

PUBLIC

Clears the panel state.
fiftyone.operators.panel.PanelRefState.apply

fiftyone.operators.panel.PanelRefState.html#apply

Function

Method

PUBLIC

Applies the state to the panel.
fiftyone.operators.panel.PanelRefData

fiftyone.operators.panel.PanelRefData.html

Class

Class

PUBLIC

Class representing the data of a panel.
fiftyone.operators.panel.PanelRefData.set

fiftyone.operators.panel.PanelRefData.html#set

Function

Method

PUBLIC

Sets some panel data.
fiftyone.operators.panel.PanelRefData.get

fiftyone.operators.panel.PanelRefData.html#get

Function

Method

PUBLIC

Gets a value from the dictionary.
fiftyone.operators.panel.PanelRefData.clear

fiftyone.operators.panel.PanelRefData.html#clear

Function

Method

PUBLIC

Clears the panel data.
fiftyone.operators.panel.PanelRef

fiftyone.operators.panel.PanelRef.html

Class

Class

PUBLIC

Class representing a panel.
fiftyone.operators.panel.PanelRef.__init__

fiftyone.operators.panel.PanelRef.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.panel.PanelRef._ctx

fiftyone.operators.panel.PanelRef.html#_ctx

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.panel.PanelRef._state

fiftyone.operators.panel.PanelRef.html#_state

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.panel.PanelRef._data

fiftyone.operators.panel.PanelRef.html#_data

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.panel.PanelRef.data

fiftyone.operators.panel.PanelRef.html#data

Attribute

Property

PUBLIC

Panel data.
fiftyone.operators.panel.PanelRef.state

fiftyone.operators.panel.PanelRef.html#state

Attribute

Property

PUBLIC

Panel state.
fiftyone.operators.panel.PanelRef.id

fiftyone.operators.panel.PanelRef.html#id

Attribute

Property

PUBLIC

Panel ID.
fiftyone.operators.panel.PanelRef.close

fiftyone.operators.panel.PanelRef.html#close

Function

Method

PUBLIC

Closes the panel.
fiftyone.operators.panel.PanelRef.set_state

fiftyone.operators.panel.PanelRef.html#set_state

Function

Method

PUBLIC

Sets some panel state.
fiftyone.operators.panel.PanelRef.get_state

fiftyone.operators.panel.PanelRef.html#get_state

Function

Method

PUBLIC

Gets some panel state.
fiftyone.operators.panel.PanelRef.set_data

fiftyone.operators.panel.PanelRef.html#set_data

Function

Method

PUBLIC

Sets some panel data.
fiftyone.operators.panel.PanelRef.set_title

fiftyone.operators.panel.PanelRef.html#set_title

Function

Method

PUBLIC

Sets the title of the panel.
fiftyone.operators.registry.get_operator

fiftyone.operators.registry.html#get_operator

Function

Function

PUBLIC

Gets the operator with the given URI.
fiftyone.operators.registry.list_operators

fiftyone.operators.registry.html#list_operators

Function

Function

PUBLIC

Returns all available operators.
fiftyone.operators.registry.operator_exists

fiftyone.operators.registry.html#operator_exists

Function

Function

PUBLIC

Checks if the given operator exists.
fiftyone.operators.registry.OperatorRegistry

fiftyone.operators.registry.OperatorRegistry.html

Class

Class

PUBLIC

Operator registry.
fiftyone.operators.registry.OperatorRegistry.__init__

fiftyone.operators.registry.OperatorRegistry.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.registry.OperatorRegistry.plugin_contexts

fiftyone.operators.registry.OperatorRegistry.html#plugin_contexts

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.registry.OperatorRegistry.list_operators

fiftyone.operators.registry.OperatorRegistry.html#list_operators

Function

Method

PUBLIC

Lists the available FiftyOne operators.
fiftyone.operators.registry.OperatorRegistry.list_errors

fiftyone.operators.registry.OperatorRegistry.html#list_errors

Function

Method

PUBLIC

Lists the errors that occurred during operator loading.
fiftyone.operators.registry.OperatorRegistry.operator_exists

fiftyone.operators.registry.OperatorRegistry.html#operator_exists

Function

Method

PUBLIC

Checks if the operator exists.
fiftyone.operators.registry.OperatorRegistry.can_execute

fiftyone.operators.registry.OperatorRegistry.html#can_execute

Function

Method

PUBLIC

Whether the operator can be executed.
fiftyone.operators.registry.OperatorRegistry.get_operator

fiftyone.operators.registry.OperatorRegistry.html#get_operator

Function

Method

PUBLIC

Retrieves an operator by its URI.
fiftyone.operators.store.models.KeyDocument

fiftyone.operators.store.models.KeyDocument.html

Class

Class

PUBLIC

Model representing a key in the store.
fiftyone.operators.store.models.KeyDocument.store_name

fiftyone.operators.store.models.KeyDocument.html#store_name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.operators.store.models.KeyDocument.key

fiftyone.operators.store.models.KeyDocument.html#key

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.operators.store.models.KeyDocument.value

fiftyone.operators.store.models.KeyDocument.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.operators.store.models.KeyDocument._id

fiftyone.operators.store.models.KeyDocument.html#_id

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.operators.store.models.KeyDocument.dataset_id

fiftyone.operators.store.models.KeyDocument.html#dataset_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.operators.store.models.KeyDocument.created_at

fiftyone.operators.store.models.KeyDocument.html#created_at

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.operators.store.models.KeyDocument.updated_at

fiftyone.operators.store.models.KeyDocument.html#updated_at

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.operators.store.models.KeyDocument.expires_at

fiftyone.operators.store.models.KeyDocument.html#expires_at

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.operators.store.models.KeyDocument.get_expiration

fiftyone.operators.store.models.KeyDocument.html#get_expiration

Function

Static Method

PUBLIC

Gets the expiration date for a key with the given TTL.
fiftyone.operators.store.models.KeyDocument.to_mongo_dict

fiftyone.operators.store.models.KeyDocument.html#to_mongo_dict

Function

Method

PUBLIC

Serializes the document to a MongoDB dictionary.
fiftyone.operators.store.models.StoreDocument

fiftyone.operators.store.models.StoreDocument.html

Class

Class

PUBLIC

Model representing a Store.
fiftyone.operators.store.models.StoreDocument.key

fiftyone.operators.store.models.StoreDocument.html#key

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.operators.store.models.StoreDocument.value

fiftyone.operators.store.models.StoreDocument.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.operators.store.models.StoreDocument.metadata

fiftyone.operators.store.models.StoreDocument.html#metadata

Attribute

Property

PUBLIC

The metadata associated with the store.
fiftyone.operators.store.service.ExecutionStoreService

fiftyone.operators.store.service.ExecutionStoreService.html

Class

Class

PUBLIC

Service for managing execution store operations.
fiftyone.operators.store.service.ExecutionStoreService.__init__

fiftyone.operators.store.service.ExecutionStoreService.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.store.service.ExecutionStoreService._dataset_id

fiftyone.operators.store.service.ExecutionStoreService.html#_dataset_id

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.store.service.ExecutionStoreService._repo

fiftyone.operators.store.service.ExecutionStoreService.html#_repo

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.store.service.ExecutionStoreService.create_store

fiftyone.operators.store.service.ExecutionStoreService.html#create_store

Function

Method

PUBLIC

Creates a new store with the specified name.
fiftyone.operators.store.service.ExecutionStoreService.get_store

fiftyone.operators.store.service.ExecutionStoreService.html#get_store

Function

Method

PUBLIC

Gets the specified store for the current context.
fiftyone.operators.store.service.ExecutionStoreService.list_stores

fiftyone.operators.store.service.ExecutionStoreService.html#list_stores

Function

Method

PUBLIC

Lists all stores for the current context.
fiftyone.operators.store.service.ExecutionStoreService.count_stores

fiftyone.operators.store.service.ExecutionStoreService.html#count_stores

Function

Method

PUBLIC

Counts the stores for the current context.
fiftyone.operators.store.service.ExecutionStoreService.has_store

fiftyone.operators.store.service.ExecutionStoreService.html#has_store

Function

Method

PUBLIC

Determines whether the specified store exists in the current context.
fiftyone.operators.store.service.ExecutionStoreService.delete_store

fiftyone.operators.store.service.ExecutionStoreService.html#delete_store

Function

Method

PUBLIC

Deletes the specified store.
fiftyone.operators.store.service.ExecutionStoreService.set_key

fiftyone.operators.store.service.ExecutionStoreService.html#set_key

Function

Method

PUBLIC

Sets the value of a key in the specified store.
fiftyone.operators.store.service.ExecutionStoreService.has_key

fiftyone.operators.store.service.ExecutionStoreService.html#has_key

Function

Method

PUBLIC

Determines whether the specified key exists in the specified store.
fiftyone.operators.store.service.ExecutionStoreService.get_key

fiftyone.operators.store.service.ExecutionStoreService.html#get_key

Function

Method

PUBLIC

Retrieves the value of a key from the specified store.
fiftyone.operators.store.service.ExecutionStoreService.delete_key

fiftyone.operators.store.service.ExecutionStoreService.html#delete_key

Function

Method

PUBLIC

Deletes the specified key from the store.
fiftyone.operators.store.service.ExecutionStoreService.update_ttl

fiftyone.operators.store.service.ExecutionStoreService.html#update_ttl

Function

Method

PUBLIC

Updates the TTL of the specified key in the store.
fiftyone.operators.store.service.ExecutionStoreService.list_keys

fiftyone.operators.store.service.ExecutionStoreService.html#list_keys

Function

Method

PUBLIC

Lists all keys in the specified store.
fiftyone.operators.store.service.ExecutionStoreService.count_keys

fiftyone.operators.store.service.ExecutionStoreService.html#count_keys

Function

Method

PUBLIC

Counts the keys in the specified store.
fiftyone.operators.store.service.ExecutionStoreService.cleanup

fiftyone.operators.store.service.ExecutionStoreService.html#cleanup

Function

Method

PUBLIC

Deletes all stores associated with the current context.
fiftyone.operators.store.service.ExecutionStoreService.has_store_global

fiftyone.operators.store.service.ExecutionStoreService.html#has_store_global

Function

Method

PUBLIC

Determines whether a store with the given name exists across all datasets and the global context.
fiftyone.operators.store.service.ExecutionStoreService.list_stores_global

fiftyone.operators.store.service.ExecutionStoreService.html#list_stores_global

Function

Method

PUBLIC

Lists the stores across all datasets and the global context.
fiftyone.operators.store.service.ExecutionStoreService.count_stores_global

fiftyone.operators.store.service.ExecutionStoreService.html#count_stores_global

Function

Method

PUBLIC

Counts the stores across all datasets and the global context.
fiftyone.operators.store.service.ExecutionStoreService.delete_store_global

fiftyone.operators.store.service.ExecutionStoreService.html#delete_store_global

Function

Method

PUBLIC

Deletes the specified store across all datasets and the global context.
fiftyone.operators.store.store.ExecutionStore

fiftyone.operators.store.store.ExecutionStore.html

Class

Class

PUBLIC

Execution store.
fiftyone.operators.store.store.ExecutionStore.__init__

fiftyone.operators.store.store.ExecutionStore.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.store.store.ExecutionStore.store_name

fiftyone.operators.store.store.ExecutionStore.html#store_name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.store.store.ExecutionStore._store_service

fiftyone.operators.store.store.ExecutionStore.html#_store_service

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.store.store.ExecutionStore.create

fiftyone.operators.store.store.ExecutionStore.html#create

Function

Static Method

PUBLIC

Undocumented
fiftyone.operators.store.store.ExecutionStore.list_stores

fiftyone.operators.store.store.ExecutionStore.html#list_stores

Function

Method

PUBLIC

Lists all stores in the execution store.
fiftyone.operators.store.store.ExecutionStore.get

fiftyone.operators.store.store.ExecutionStore.html#get

Function

Method

PUBLIC

Retrieves a value from the store by its key.
fiftyone.operators.store.store.ExecutionStore.set

fiftyone.operators.store.store.ExecutionStore.html#set

Function

Method

PUBLIC

Sets a value in the store with an optional TTL.
fiftyone.operators.store.store.ExecutionStore.delete

fiftyone.operators.store.store.ExecutionStore.html#delete

Function

Method

PUBLIC

Deletes a key from the store.
fiftyone.operators.store.store.ExecutionStore.has

fiftyone.operators.store.store.ExecutionStore.html#has

Function

Method

PUBLIC

Checks if the store has a specific key.
fiftyone.operators.store.store.ExecutionStore.clear

fiftyone.operators.store.store.ExecutionStore.html#clear

Function

Method

PUBLIC

Clears all the data in the store.
fiftyone.operators.store.store.ExecutionStore.update_ttl

fiftyone.operators.store.store.ExecutionStore.html#update_ttl

Function

Method

PUBLIC

Updates the TTL for a specific key.
fiftyone.operators.store.store.ExecutionStore.get_metadata

fiftyone.operators.store.store.ExecutionStore.html#get_metadata

Function

Method

PUBLIC

Retrieves the metadata for the given key.
fiftyone.operators.store.store.ExecutionStore.list_keys

fiftyone.operators.store.store.ExecutionStore.html#list_keys

Function

Method

PUBLIC

Lists all keys in the store.
fiftyone.internal.secrets.secret.ISecret

fiftyone.internal.secrets.secret.ISecret.html

Class

Class

PUBLIC

Secret interface.
fiftyone.internal.secrets.secret.ISecret.key

fiftyone.internal.secrets.secret.ISecret.html#key

Attribute

Property

PUBLIC

The secret's string identifier.
fiftyone.internal.secrets.secret.ISecret.value

fiftyone.internal.secrets.secret.ISecret.html#value

Attribute

Property

PUBLIC

The secret's value.
fiftyone.internal.secrets.secret.AbstractSecret

fiftyone.internal.secrets.secret.AbstractSecret.html

Class

Class

PUBLIC

Abstract secret.
fiftyone.internal.secrets.secret.AbstractSecret.__init__

fiftyone.internal.secrets.secret.AbstractSecret.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.internal.secrets.secret.AbstractSecret._key

fiftyone.internal.secrets.secret.AbstractSecret.html#_key

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.internal.secrets.secret.AbstractSecret._value

fiftyone.internal.secrets.secret.AbstractSecret.html#_value

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.internal.secrets.secret.AbstractSecret.__repr__

fiftyone.internal.secrets.secret.AbstractSecret.html#__repr__

Function

Method

PUBLIC

Undocumented
fiftyone.internal.secrets.secret.AbstractSecret.__str__

fiftyone.internal.secrets.secret.AbstractSecret.html#__str__

Function

Method

PUBLIC

Undocumented
fiftyone.internal.secrets.secret.AbstractSecret.__bool__

fiftyone.internal.secrets.secret.AbstractSecret.html#__bool__

Function

Method

PUBLIC

Undocumented
fiftyone.internal.secrets.secret.AbstractSecret.__eq__

fiftyone.internal.secrets.secret.AbstractSecret.html#__eq__

Function

Method

PUBLIC

Secrets are equal if their values are equal.
fiftyone.internal.secrets.secret.AbstractSecret.key

fiftyone.internal.secrets.secret.AbstractSecret.html#key

Attribute

Property

PUBLIC

The secret's string identifier.
fiftyone.internal.secrets.secret.AbstractSecret.value

fiftyone.internal.secrets.secret.AbstractSecret.html#value

Attribute

Property

PUBLIC

The secret's value.
fiftyone.internal.secrets.secret.AbstractSecret.is_encrypted

fiftyone.internal.secrets.secret.AbstractSecret.html#is_encrypted

Attribute

Property

PUBLIC

Whether the secret is encrypted.
fiftyone.internal.secrets.secret.UnencryptedSecret

fiftyone.internal.secrets.secret.UnencryptedSecret.html

Class

Class

PUBLIC

FiftyOne secret with plaintext value.
fiftyone.internal.secrets.secret.UnencryptedSecret.__init__

fiftyone.internal.secrets.secret.UnencryptedSecret.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.internal.secrets.secret.UnencryptedSecret.key

fiftyone.internal.secrets.secret.UnencryptedSecret.html#key

Attribute

Property

PUBLIC

The secret's string identifier.
fiftyone.internal.secrets.secret.UnencryptedSecret.value

fiftyone.internal.secrets.secret.UnencryptedSecret.html#value

Attribute

Property

PUBLIC

The secret's value.
fiftyone.internal.secrets.secret.UnencryptedSecret.is_encrypted

fiftyone.internal.secrets.secret.UnencryptedSecret.html#is_encrypted

Attribute

Property

PUBLIC

Whether the secret is encrypted.
fiftyone.internal.secrets.providers.iprovider.ISecretProvider

fiftyone.internal.secrets.providers.iprovider.ISecretProvider.html

Class

Class

PUBLIC

No class docstring; 4/4 methods documented
fiftyone.internal.secrets.providers.iprovider.ISecretProvider.get

fiftyone.internal.secrets.providers.iprovider.ISecretProvider.html#get

Function

Method

PUBLIC

Get a secret by key.
fiftyone.internal.secrets.providers.iprovider.ISecretProvider.get_sync

fiftyone.internal.secrets.providers.iprovider.ISecretProvider.html#get_sync

Function

Method

PUBLIC

Get a secret by key in a synchronous context.
fiftyone.internal.secrets.providers.iprovider.ISecretProvider.get_multiple

fiftyone.internal.secrets.providers.iprovider.ISecretProvider.html#get_multiple

Function

Method

PUBLIC

Get multiple secrets by key.
fiftyone.internal.secrets.providers.iprovider.ISecretProvider.search

fiftyone.internal.secrets.providers.iprovider.ISecretProvider.html#search

Function

Method

PUBLIC

Get secrets with keys matching regex
fiftyone.internal.secrets.providers.local.EnvSecretProvider

fiftyone.internal.secrets.providers.local.EnvSecretProvider.html

Class

Class

PUBLIC

Exposes secrets from environment variables.
fiftyone.internal.secrets.providers.local.EnvSecretProvider.get

fiftyone.internal.secrets.providers.local.EnvSecretProvider.html#get

Function

Method

PUBLIC

Get a secret by key.
fiftyone.internal.secrets.providers.local.EnvSecretProvider.get_sync

fiftyone.internal.secrets.providers.local.EnvSecretProvider.html#get_sync

Function

Method

PUBLIC

Get a secret by key in a synchronous context.
fiftyone.internal.secrets.providers.local.EnvSecretProvider.get_multiple

fiftyone.internal.secrets.providers.local.EnvSecretProvider.html#get_multiple

Function

Method

PUBLIC

Get multiple secrets by key.
fiftyone.internal.secrets.providers.local.EnvSecretProvider.search

fiftyone.internal.secrets.providers.local.EnvSecretProvider.html#search

Function

Method

PUBLIC

Get secrets with keys matching regex
fiftyone.plugins.secrets.PluginSecretsResolver

fiftyone.plugins.secrets.PluginSecretsResolver.html

Class

Class

PUBLIC

Injects secrets from environmental variables into the execution context.
fiftyone.plugins.secrets.PluginSecretsResolver._instance

fiftyone.plugins.secrets.PluginSecretsResolver.html#_instance

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.plugins.secrets.PluginSecretsResolver._registered_secrets

fiftyone.plugins.secrets.PluginSecretsResolver.html#_registered_secrets

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.plugins.secrets.PluginSecretsResolver.__new__

fiftyone.plugins.secrets.PluginSecretsResolver.html#__new__

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.secrets.PluginSecretsResolver.register_operator

fiftyone.plugins.secrets.PluginSecretsResolver.html#register_operator

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.secrets.PluginSecretsResolver.client

fiftyone.plugins.secrets.PluginSecretsResolver.html#client

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.secrets.PluginSecretsResolver.get_secret

fiftyone.plugins.secrets.PluginSecretsResolver.html#get_secret

Function

Method

PUBLIC

Get the value of a secret.
fiftyone.plugins.secrets.PluginSecretsResolver.get_secret_sync

fiftyone.plugins.secrets.PluginSecretsResolver.html#get_secret_sync

Function

Method

PUBLIC

Get the value of a secret.
fiftyone.plugins.secrets._get_secrets_client

fiftyone.plugins.secrets.html#_get_secrets_client

Function

Function

PRIVATE

Undocumented
fiftyone.plugins.secrets.SecretsDictionary

fiftyone.plugins.secrets.SecretsDictionary.html

Class

Class

PUBLIC

A more secure dictionary for accessing plugin secrets in operators that will attempt to resolve missing plugin secrets upon access.
fiftyone.plugins.secrets.SecretsDictionary.__init__

fiftyone.plugins.secrets.SecretsDictionary.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.secrets.SecretsDictionary.__frozen

fiftyone.plugins.secrets.SecretsDictionary.html#__frozen

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.plugins.secrets.SecretsDictionary.__required_keys

fiftyone.plugins.secrets.SecretsDictionary.html#__required_keys

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.plugins.secrets.SecretsDictionary.__secrets

fiftyone.plugins.secrets.SecretsDictionary.html#__secrets

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.plugins.secrets.SecretsDictionary._operator_uri

fiftyone.plugins.secrets.SecretsDictionary.html#_operator_uri

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.plugins.secrets.SecretsDictionary._resolver

fiftyone.plugins.secrets.SecretsDictionary.html#_resolver

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.plugins.secrets.SecretsDictionary.__len__

fiftyone.plugins.secrets.SecretsDictionary.html#__len__

Function

Method

PUBLIC

Returns the number of secrets defined in the plugin definition
fiftyone.plugins.secrets.SecretsDictionary.__iter__

fiftyone.plugins.secrets.SecretsDictionary.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.secrets.SecretsDictionary.__eq__

fiftyone.plugins.secrets.SecretsDictionary.html#__eq__

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.secrets.SecretsDictionary.__ne__

fiftyone.plugins.secrets.SecretsDictionary.html#__ne__

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.secrets.SecretsDictionary.__getitem__

fiftyone.plugins.secrets.SecretsDictionary.html#__getitem__

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.secrets.SecretsDictionary.__setattr__

fiftyone.plugins.secrets.SecretsDictionary.html#__setattr__

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.secrets.SecretsDictionary.__setitem__

fiftyone.plugins.secrets.SecretsDictionary.html#__setitem__

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.secrets.SecretsDictionary.__deepcopy__

fiftyone.plugins.secrets.SecretsDictionary.html#__deepcopy__

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.secrets.SecretsDictionary.__dict__

fiftyone.plugins.secrets.SecretsDictionary.html#__dict__

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.secrets.SecretsDictionary.copy

fiftyone.plugins.secrets.SecretsDictionary.html#copy

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.secrets.SecretsDictionary.keys

fiftyone.plugins.secrets.SecretsDictionary.html#keys

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.secrets.SecretsDictionary.values

fiftyone.plugins.secrets.SecretsDictionary.html#values

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.secrets.SecretsDictionary.items

fiftyone.plugins.secrets.SecretsDictionary.html#items

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.secrets.SecretsDictionary.get

fiftyone.plugins.secrets.SecretsDictionary.html#get

Function

Method

PUBLIC

Undocumented
fiftyone.operators.executor.logger

fiftyone.operators.executor.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionRunState

fiftyone.operators.executor.ExecutionRunState.html

Class

Class

PUBLIC

Enumeration of the available operator run states.
fiftyone.operators.executor.ExecutionRunState.SCHEDULED

fiftyone.operators.executor.ExecutionRunState.html#SCHEDULED

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionRunState.QUEUED

fiftyone.operators.executor.ExecutionRunState.html#QUEUED

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionRunState.RUNNING

fiftyone.operators.executor.ExecutionRunState.html#RUNNING

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionRunState.COMPLETED

fiftyone.operators.executor.ExecutionRunState.html#COMPLETED

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionRunState.FAILED

fiftyone.operators.executor.ExecutionRunState.html#FAILED

Attribute

Constant

PUBLIC

Undocumented
fiftyone.operators.executor.InvocationRequest

fiftyone.operators.executor.InvocationRequest.html

Class

Class

PUBLIC

Represents a request to invoke an operator.
fiftyone.operators.executor.InvocationRequest.params

fiftyone.operators.executor.InvocationRequest.html#params

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.InvocationRequest.__init__

fiftyone.operators.executor.InvocationRequest.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.executor.InvocationRequest.operator_uri

fiftyone.operators.executor.InvocationRequest.html#operator_uri

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.InvocationRequest.to_json

fiftyone.operators.executor.InvocationRequest.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionProgress

fiftyone.operators.executor.ExecutionProgress.html

Class

Class

PUBLIC

Represents the status of an operator execution.
fiftyone.operators.executor.ExecutionProgress.progress

fiftyone.operators.executor.ExecutionProgress.html#progress

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionProgress.label

fiftyone.operators.executor.ExecutionProgress.html#label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionProgress.__init__

fiftyone.operators.executor.ExecutionProgress.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionProgress.updated_at

fiftyone.operators.executor.ExecutionProgress.html#updated_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.Executor

fiftyone.operators.executor.Executor.html

Class

Class

PUBLIC

Handles the execution phase of the operator lifecycle.
fiftyone.operators.executor.Executor.__init__

fiftyone.operators.executor.Executor.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.executor.Executor._requests

fiftyone.operators.executor.Executor.html#_requests

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.Executor._logs

fiftyone.operators.executor.Executor.html#_logs

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.Executor.trigger

fiftyone.operators.executor.Executor.html#trigger

Function

Method

PUBLIC

Triggers an invocation of the operator with the given name.
fiftyone.operators.executor.Executor.log

fiftyone.operators.executor.Executor.html#log

Function

Method

PUBLIC

Logs a message.
fiftyone.operators.executor.Executor.to_json

fiftyone.operators.executor.Executor.html#to_json

Function

Method

PUBLIC

Undocumented
fiftyone.operators.executor.execute_operator

fiftyone.operators.executor.html#execute_operator

Function

Function

PUBLIC

Executes the operator with the given name.
fiftyone.operators.executor._parse_ctx

fiftyone.operators.executor.html#_parse_ctx

Function

Function

PRIVATE

Undocumented
fiftyone.operators.executor.execute_or_delegate_operator

fiftyone.operators.executor.html#execute_or_delegate_operator

Function

Function

PUBLIC

Executes the operator with the given name.
fiftyone.operators.executor.prepare_operator_executor

fiftyone.operators.executor.html#prepare_operator_executor

Function

Function

PUBLIC

Undocumented
fiftyone.operators.executor.do_execute_operator

fiftyone.operators.executor.html#do_execute_operator

Function

Function

PUBLIC

Undocumented
fiftyone.operators.executor.resolve_type

fiftyone.operators.executor.html#resolve_type

Function

Function

PUBLIC

Resolves the inputs property type of the operator with the given name.
fiftyone.operators.executor.resolve_type_with_context

fiftyone.operators.executor.html#resolve_type_with_context

Function

Function

PUBLIC

Resolves the "inputs" or "outputs" schema of an operator with the given context.
fiftyone.operators.executor.resolve_execution_options

fiftyone.operators.executor.html#resolve_execution_options

Function

Function

PUBLIC

Resolves the execution options of the operator with the given name.
fiftyone.operators.executor.resolve_placement

fiftyone.operators.executor.html#resolve_placement

Function

Function

PUBLIC

Resolves the placement of the operator with the given name.
fiftyone.operators.executor.ExecutionContext

fiftyone.operators.executor.ExecutionContext.html

Class

Class

PUBLIC

Represents the execution context of an operator.
fiftyone.operators.executor.ExecutionContext.request_params

fiftyone.operators.executor.ExecutionContext.html#request_params

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionContext.executor

fiftyone.operators.executor.ExecutionContext.html#executor

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionContext.__init__

fiftyone.operators.executor.ExecutionContext.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionContext.params

fiftyone.operators.executor.ExecutionContext.html#params

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionContext.user

fiftyone.operators.executor.ExecutionContext.html#user

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionContext._dataset

fiftyone.operators.executor.ExecutionContext.html#_dataset

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionContext._view

fiftyone.operators.executor.ExecutionContext.html#_view

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionContext._ops

fiftyone.operators.executor.ExecutionContext.html#_ops

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionContext._set_progress

fiftyone.operators.executor.ExecutionContext.html#_set_progress

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionContext._delegated_operation_id

fiftyone.operators.executor.ExecutionContext.html#_delegated_operation_id

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionContext._operator_uri

fiftyone.operators.executor.ExecutionContext.html#_operator_uri

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionContext._secrets

fiftyone.operators.executor.ExecutionContext.html#_secrets

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionContext._secrets_client

fiftyone.operators.executor.ExecutionContext.html#_secrets_client

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionContext._required_secret_keys

fiftyone.operators.executor.ExecutionContext.html#_required_secret_keys

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionContext._panel_state

fiftyone.operators.executor.ExecutionContext.html#_panel_state

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionContext._panel

fiftyone.operators.executor.ExecutionContext.html#_panel

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionContext.dataset

fiftyone.operators.executor.ExecutionContext.html#dataset

Attribute

Property

PUBLIC

The fiftyone.core.dataset.Dataset being operated on.
fiftyone.operators.executor.ExecutionContext.dataset_name

fiftyone.operators.executor.ExecutionContext.html#dataset_name

Attribute

Property

PUBLIC

The name of the fiftyone.core.dataset.Dataset being operated on.
fiftyone.operators.executor.ExecutionContext.dataset_id

fiftyone.operators.executor.ExecutionContext.html#dataset_id

Attribute

Property

PUBLIC

The ID of the fiftyone.core.dataset.Dataset being operated on.
fiftyone.operators.executor.ExecutionContext.view

fiftyone.operators.executor.ExecutionContext.html#view

Attribute

Property

PUBLIC

The fiftyone.core.view.DatasetView being operated on.
fiftyone.operators.executor.ExecutionContext.target_view

fiftyone.operators.executor.ExecutionContext.html#target_view

Function

Method

PUBLIC

The target fiftyone.core.view.DatasetView for the operator being executed.
fiftyone.operators.executor.ExecutionContext.has_custom_view

fiftyone.operators.executor.ExecutionContext.html#has_custom_view

Attribute

Property

PUBLIC

Whether the operator has a custom view.
fiftyone.operators.executor.ExecutionContext.spaces

fiftyone.operators.executor.ExecutionContext.html#spaces

Attribute

Property

PUBLIC

The current spaces layout in the FiftyOne App.
fiftyone.operators.executor.ExecutionContext.selected

fiftyone.operators.executor.ExecutionContext.html#selected

Attribute

Property

PUBLIC

The list of selected sample IDs (if any).
fiftyone.operators.executor.ExecutionContext.selected_labels

fiftyone.operators.executor.ExecutionContext.html#selected_labels

Attribute

Property

PUBLIC

A list of selected labels (if any).
fiftyone.operators.executor.ExecutionContext.extended_selection

fiftyone.operators.executor.ExecutionContext.html#extended_selection

Attribute

Property

PUBLIC

The extended selection of the view (if any).
fiftyone.operators.executor.ExecutionContext.current_sample

fiftyone.operators.executor.ExecutionContext.html#current_sample

Attribute

Property

PUBLIC

The ID of the current sample being processed (if any).
fiftyone.operators.executor.ExecutionContext.user_id

fiftyone.operators.executor.ExecutionContext.html#user_id

Attribute

Property

PUBLIC

The ID of the user executing the operation, if known.
fiftyone.operators.executor.ExecutionContext.user_request_token

fiftyone.operators.executor.ExecutionContext.html#user_request_token

Attribute

Property

PUBLIC

The request token authenticating the user executing the operation, if known.
fiftyone.operators.executor.ExecutionContext.panel_id

fiftyone.operators.executor.ExecutionContext.html#panel_id

Attribute

Property

PUBLIC

The ID of the panel that invoked the operator, if any.
fiftyone.operators.executor.ExecutionContext.panel_state

fiftyone.operators.executor.ExecutionContext.html#panel_state

Attribute

Property

PUBLIC

The current panel state.
fiftyone.operators.executor.ExecutionContext.panel

fiftyone.operators.executor.ExecutionContext.html#panel

Attribute

Property

PUBLIC

A fiftyone.operators.panel.PanelRef instance that you can use to read and write the state and data of the current panel.
fiftyone.operators.executor.ExecutionContext.delegated

fiftyone.operators.executor.ExecutionContext.html#delegated

Attribute

Property

PUBLIC

Whether the operation was delegated.
fiftyone.operators.executor.ExecutionContext.requesting_delegated_execution

fiftyone.operators.executor.ExecutionContext.html#requesting_delegated_execution

Attribute

Property

PUBLIC

Whether delegated execution was requested for the operation.
fiftyone.operators.executor.ExecutionContext.delegation_target

fiftyone.operators.executor.ExecutionContext.html#delegation_target

Attribute

Property

PUBLIC

The orchestrator to which the operation was delegated (if any).
fiftyone.operators.executor.ExecutionContext.results

fiftyone.operators.executor.ExecutionContext.html#results

Attribute

Property

PUBLIC

A dict of results for the current operation.
fiftyone.operators.executor.ExecutionContext.secrets

fiftyone.operators.executor.ExecutionContext.html#secrets

Attribute

Property

PUBLIC

A read-only mapping of keys to their resolved values.
fiftyone.operators.executor.ExecutionContext.ops

fiftyone.operators.executor.ExecutionContext.html#ops

Attribute

Property

PUBLIC

A fiftyone.operators.operations.Operations instance that you can use to trigger builtin operations on the current context.
fiftyone.operators.executor.ExecutionContext.group_slice

fiftyone.operators.executor.ExecutionContext.html#group_slice

Attribute

Property

PUBLIC

The current group slice of the view (if any).
fiftyone.operators.executor.ExecutionContext.query_performance

fiftyone.operators.executor.ExecutionContext.html#query_performance

Attribute

Property

PUBLIC

Whether query performance is enabled.
fiftyone.operators.executor.ExecutionContext.prompt

fiftyone.operators.executor.ExecutionContext.html#prompt

Function

Method

PUBLIC

Prompts the user to execute the operator with the given URI.
fiftyone.operators.executor.ExecutionContext.secret

fiftyone.operators.executor.ExecutionContext.html#secret

Function

Method

PUBLIC

Retrieves the secret with the given key.
fiftyone.operators.executor.ExecutionContext.resolve_secret_values

fiftyone.operators.executor.ExecutionContext.html#resolve_secret_values

Function

Method

PUBLIC

Resolves the values of the given secrets keys.
fiftyone.operators.executor.ExecutionContext.trigger

fiftyone.operators.executor.ExecutionContext.html#trigger

Function

Method

PUBLIC

Triggers an invocation of the operator with the given name.
fiftyone.operators.executor.ExecutionContext.log

fiftyone.operators.executor.ExecutionContext.html#log

Function

Method

PUBLIC

Logs a message to the browser console.
fiftyone.operators.executor.ExecutionContext.set_progress

fiftyone.operators.executor.ExecutionContext.html#set_progress

Function

Method

PUBLIC

Sets the progress of the current operation.
fiftyone.operators.executor.ExecutionContext.store

fiftyone.operators.executor.ExecutionContext.html#store

Function

Method

PUBLIC

Retrieves the execution store with the given name.
fiftyone.operators.executor.ExecutionContext._get_serialized_request_params

fiftyone.operators.executor.ExecutionContext.html#_get_serialized_request_params

Function

Method

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionContext.serialize

fiftyone.operators.executor.ExecutionContext.html#serialize

Function

Method

PUBLIC

Serializes the execution context.
fiftyone.operators.executor.ExecutionContext.to_dict

fiftyone.operators.executor.ExecutionContext.html#to_dict

Function

Method

PUBLIC

Returns the properties of the execution context as a dict.
fiftyone.operators.executor.ExecutionResult

fiftyone.operators.executor.ExecutionResult.html

Class

Class

PUBLIC

Represents the result of an operator execution.
fiftyone.operators.executor.ExecutionResult.result

fiftyone.operators.executor.ExecutionResult.html#result

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionResult.executor

fiftyone.operators.executor.ExecutionResult.html#executor

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionResult.error

fiftyone.operators.executor.ExecutionResult.html#error

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionResult.error_message

fiftyone.operators.executor.ExecutionResult.html#error_message

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionResult.validation_ctx

fiftyone.operators.executor.ExecutionResult.html#validation_ctx

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionResult.delegated

fiftyone.operators.executor.ExecutionResult.html#delegated

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionResult.outputs_schema

fiftyone.operators.executor.ExecutionResult.html#outputs_schema

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionResult.__init__

fiftyone.operators.executor.ExecutionResult.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionResult.is_generator

fiftyone.operators.executor.ExecutionResult.html#is_generator

Attribute

Property

PUBLIC

Whether the result is a generator or an async generator.
fiftyone.operators.executor.ExecutionResult.raise_exceptions

fiftyone.operators.executor.ExecutionResult.html#raise_exceptions

Function

Method

PUBLIC

Raises an ExecutionError (only) if the operation failed.
fiftyone.operators.executor.ExecutionResult.to_exception

fiftyone.operators.executor.ExecutionResult.html#to_exception

Function

Method

PUBLIC

Returns an ExecutionError representing a failed execution result.
fiftyone.operators.executor.ExecutionResult.to_json

fiftyone.operators.executor.ExecutionResult.html#to_json

Function

Method

PUBLIC

Returns a JSON dict representation of the result.
fiftyone.operators.executor.ExecutionError

fiftyone.operators.executor.ExecutionError.html

Class

Exception

PUBLIC

An error that occurs while executing an operator.
fiftyone.operators.executor.ValidationError

fiftyone.operators.executor.ValidationError.html

Class

Class

PUBLIC

A validation error.
fiftyone.operators.executor.ValidationError.__init__

fiftyone.operators.executor.ValidationError.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.executor.ValidationError.reason

fiftyone.operators.executor.ValidationError.html#reason

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ValidationError.error_message

fiftyone.operators.executor.ValidationError.html#error_message

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ValidationError.path

fiftyone.operators.executor.ValidationError.html#path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ValidationError.custom

fiftyone.operators.executor.ValidationError.html#custom

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ValidationError.to_json

fiftyone.operators.executor.ValidationError.html#to_json

Function

Method

PUBLIC

Returns a JSON dict representation of the error.
fiftyone.operators.executor.ValidationContext

fiftyone.operators.executor.ValidationContext.html

Class

Class

PUBLIC

Represents the validation context of an operator.
fiftyone.operators.executor.ValidationContext.__init__

fiftyone.operators.executor.ValidationContext.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.executor.ValidationContext.ctx

fiftyone.operators.executor.ValidationContext.html#ctx

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ValidationContext.params

fiftyone.operators.executor.ValidationContext.html#params

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ValidationContext.inputs_property

fiftyone.operators.executor.ValidationContext.html#inputs_property

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ValidationContext.errors

fiftyone.operators.executor.ValidationContext.html#errors

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ValidationContext.disable_schema_validation

fiftyone.operators.executor.ValidationContext.html#disable_schema_validation

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ValidationContext.invalid

fiftyone.operators.executor.ValidationContext.html#invalid

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.executor.ValidationContext.to_json

fiftyone.operators.executor.ValidationContext.html#to_json

Function

Method

PUBLIC

Returns a JSON dict representation of the context.
fiftyone.operators.executor.ValidationContext.add_error

fiftyone.operators.executor.ValidationContext.html#add_error

Function

Method

PUBLIC

Adds a validation error.
fiftyone.operators.executor.ValidationContext._validate

fiftyone.operators.executor.ValidationContext.html#_validate

Function

Method

PRIVATE

Undocumented
fiftyone.operators.executor.ValidationContext.validate_enum

fiftyone.operators.executor.ValidationContext.html#validate_enum

Function

Method

PUBLIC

Validates an enum value.
fiftyone.operators.executor.ValidationContext.validate_list

fiftyone.operators.executor.ValidationContext.html#validate_list

Function

Method

PUBLIC

Validates a list value.
fiftyone.operators.executor.ValidationContext.validate_property

fiftyone.operators.executor.ValidationContext.html#validate_property

Function

Method

PUBLIC

Validates a property value.
fiftyone.operators.executor.ValidationContext.validate_object

fiftyone.operators.executor.ValidationContext.html#validate_object

Function

Method

PUBLIC

Validates an object value.
fiftyone.operators.executor.ValidationContext.validate_primitive

fiftyone.operators.executor.ValidationContext.html#validate_primitive

Function

Method

PUBLIC

Validates a primitive value.
fiftyone.operators.executor.ValidationContext.exists_or_non_required

fiftyone.operators.executor.ValidationContext.html#exists_or_non_required

Function

Method

PUBLIC

Undocumented
fiftyone.operators.executor._convert_callables_to_operator_uris

fiftyone.operators.executor.html#_convert_callables_to_operator_uris

Function

Function

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionOptions

fiftyone.operators.executor.ExecutionOptions.html

Class

Class

PUBLIC

Represents the execution options of an operation.
fiftyone.operators.executor.ExecutionOptions.__init__

fiftyone.operators.executor.ExecutionOptions.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionOptions._allow_immediate_execution

fiftyone.operators.executor.ExecutionOptions.html#_allow_immediate_execution

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionOptions._allow_delegated_execution

fiftyone.operators.executor.ExecutionOptions.html#_allow_delegated_execution

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionOptions._default_choice_to_delegated

fiftyone.operators.executor.ExecutionOptions.html#_default_choice_to_delegated

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionOptions._available_orchestrators

fiftyone.operators.executor.ExecutionOptions.html#_available_orchestrators

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.executor.ExecutionOptions.allow_immediate_execution

fiftyone.operators.executor.ExecutionOptions.html#allow_immediate_execution

Attribute

Property

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionOptions.allow_delegated_execution

fiftyone.operators.executor.ExecutionOptions.html#allow_delegated_execution

Attribute

Property

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionOptions.default_choice_to_delegated

fiftyone.operators.executor.ExecutionOptions.html#default_choice_to_delegated

Attribute

Property

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionOptions.available_orchestrators

fiftyone.operators.executor.ExecutionOptions.html#available_orchestrators

Attribute

Property

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionOptions.orchestrator_registration_enabled

fiftyone.operators.executor.ExecutionOptions.html#orchestrator_registration_enabled

Attribute

Property

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionOptions.update

fiftyone.operators.executor.ExecutionOptions.html#update

Function

Method

PUBLIC

Undocumented
fiftyone.operators.executor.ExecutionOptions.to_dict

fiftyone.operators.executor.ExecutionOptions.html#to_dict

Function

Method

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.logger

fiftyone.factory.repos.delegated_operation_doc.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html

Class

Class

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.__init__

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.operator

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#operator

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.label

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.delegation_target

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#delegation_target

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.context

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#context

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.run_state

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#run_state

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.run_link

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#run_link

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.queued_at

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#queued_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.updated_at

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#updated_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.status

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#status

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.dataset_id

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#dataset_id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.started_at

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#started_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.pinned

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#pinned

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.completed_at

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#completed_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.failed_at

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#failed_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.scheduled_at

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#scheduled_at

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.result

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#result

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.id

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument._doc

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#_doc

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.metadata

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.from_pymongo

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#from_pymongo

Function

Method

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.to_pymongo

fiftyone.factory.repos.delegated_operation_doc.DelegatedOperationDocument.html#to_pymongo

Function

Method

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation.logger

fiftyone.factory.repos.delegated_operation.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo

fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.html

Class

Class

PUBLIC

Base Class for a delegated operation repository.
fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.queue_operation

fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.html#queue_operation

Function

Method

PUBLIC

Queue an operation to be executed by a delegated operator.
fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.update_run_state

fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.html#update_run_state

Function

Method

PUBLIC

Update the run state of an operation.
fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.update_progress

fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.html#update_progress

Function

Method

PUBLIC

Update the progress of an operation.
fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.get_queued_operations

fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.html#get_queued_operations

Function

Method

PUBLIC

Get all queued operations.
fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.get_scheduled_operations

fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.html#get_scheduled_operations

Function

Method

PUBLIC

Get all scheduled operations.
fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.get_running_operations

fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.html#get_running_operations

Function

Method

PUBLIC

Get all running operations.
fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.list_operations

fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.html#list_operations

Function

Method

PUBLIC

List all operations.
fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.delete_operation

fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.html#delete_operation

Function

Method

PUBLIC

Delete an operation.
fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.delete_for_dataset

fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.html#delete_for_dataset

Function

Method

PUBLIC

Delete an operation.
fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.set_pinned

fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.html#set_pinned

Function

Method

PUBLIC

Sets the pinned flag on / off.
fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.set_label

fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.html#set_label

Function

Method

PUBLIC

Sets the label for the delegated operation.
fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.get

fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.html#get

Function

Method

PUBLIC

Get an operation by id.
fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.count

fiftyone.factory.repos.delegated_operation.DelegatedOperationRepo.html#count

Function

Method

PUBLIC

Count all operations.
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html

Class

Class

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.COLLECTION_NAME

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#COLLECTION_NAME

Attribute

Constant

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.required_props

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#required_props

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.__init__

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo._collection

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#_collection

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.is_remote

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#is_remote

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo._get_collection

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#_get_collection

Function

Method

PRIVATE

Undocumented
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo._create_indexes

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#_create_indexes

Function

Method

PRIVATE

Undocumented
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.queue_operation

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#queue_operation

Function

Method

PUBLIC

Queue an operation to be executed by a delegated operator.
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.set_pinned

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#set_pinned

Function

Method

PUBLIC

Sets the pinned flag on / off.
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.set_label

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#set_label

Function

Method

PUBLIC

Sets the label for the delegated operation.
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.update_run_state

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#update_run_state

Function

Method

PUBLIC

Update the run state of an operation.
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.update_progress

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#update_progress

Function

Method

PUBLIC

Update the progress of an operation.
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.get_queued_operations

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#get_queued_operations

Function

Method

PUBLIC

Get all queued operations.
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.get_scheduled_operations

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#get_scheduled_operations

Function

Method

PUBLIC

Get all scheduled operations.
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.get_running_operations

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#get_running_operations

Function

Method

PUBLIC

Get all running operations.
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.list_operations

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#list_operations

Function

Method

PUBLIC

List all operations.
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.delete_operation

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#delete_operation

Function

Method

PUBLIC

Delete an operation.
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.delete_for_dataset

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#delete_for_dataset

Function

Method

PUBLIC

Delete an operation.
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.get

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#get

Function

Method

PUBLIC

Get an operation by id.
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.count

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#count

Function

Method

PUBLIC

Count all operations.
fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo._extract_search_query

fiftyone.factory.repos.delegated_operation.MongoDelegatedOperationRepo.html#_extract_search_query

Function

Method

PRIVATE

Undocumented
fiftyone.factory.repos.execution_store.ExecutionStoreRepo

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html

Class

Class

PUBLIC

Base class for execution store repositories.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.COLLECTION_NAME

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#COLLECTION_NAME

Attribute

Constant

PUBLIC

Undocumented
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.__init__

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.factory.repos.execution_store.ExecutionStoreRepo._collection

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#_collection

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.factory.repos.execution_store.ExecutionStoreRepo._dataset_id

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#_dataset_id

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.create_store

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#create_store

Function

Method

PUBLIC

Creates a store associated with the current context.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.get_store

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#get_store

Function

Method

PUBLIC

Gets a store associated with the current context.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.has_store

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#has_store

Function

Method

PUBLIC

Checks whether a store with the given name exists in the current context.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.list_stores

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#list_stores

Function

Method

PUBLIC

Lists the stores associated with the current context.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.count_stores

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#count_stores

Function

Method

PUBLIC

Counts the stores associated with the current context.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.delete_store

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#delete_store

Function

Method

PUBLIC

Deletes the specified store.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.set_key

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#set_key

Function

Method

PUBLIC

Sets or updates a key in the specified store.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.has_key

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#has_key

Function

Method

PUBLIC

Determines whether a key exists in the specified store.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.get_key

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#get_key

Function

Method

PUBLIC

Gets a key from the specified store.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.update_ttl

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#update_ttl

Function

Method

PUBLIC

Updates the TTL for a key.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.delete_key

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#delete_key

Function

Method

PUBLIC

Deletes the document that matches the store name and key, if one exists.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.list_keys

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#list_keys

Function

Method

PUBLIC

Lists all keys in the specified store.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.count_keys

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#count_keys

Function

Method

PUBLIC

Counts the keys in the specified store.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.cleanup

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#cleanup

Function

Method

PUBLIC

Deletes all stores and keys associated with the current context.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.has_store_global

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#has_store_global

Function

Method

PUBLIC

Determines whether a store with the given name exists across all datasets and the global context.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.list_stores_global

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#list_stores_global

Function

Method

PUBLIC

Lists stores across all datasets and the global context.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.count_stores_global

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#count_stores_global

Function

Method

PUBLIC

Counts stores across all datasets and the global context.
fiftyone.factory.repos.execution_store.ExecutionStoreRepo.delete_store_global

fiftyone.factory.repos.execution_store.ExecutionStoreRepo.html#delete_store_global

Function

Method

PUBLIC

Deletes the specified store across all datasets and the global context.
fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo

fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo.html

Class

Class

PUBLIC

MongoDB implementation of execution store repository.
fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo.__init__

fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo._create_indexes

fiftyone.factory.repos.execution_store.MongoExecutionStoreRepo.html#_create_indexes

Function

Method

PRIVATE

Undocumented
fiftyone.factory.repo_factory._db

fiftyone.factory.repo_factory.html#_db

Attribute

Variable

PRIVATE

Undocumented
fiftyone.factory.repo_factory._get_db

fiftyone.factory.repo_factory.html#_get_db

Function

Function

PRIVATE

Undocumented
fiftyone.factory.repo_factory.RepositoryFactory

fiftyone.factory.repo_factory.RepositoryFactory.html

Class

Class

PUBLIC

Undocumented
fiftyone.factory.repo_factory.RepositoryFactory.repos

fiftyone.factory.repo_factory.RepositoryFactory.html#repos

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.factory.repo_factory.RepositoryFactory.delegated_operation_repo

fiftyone.factory.repo_factory.RepositoryFactory.html#delegated_operation_repo

Function

Static Method

PUBLIC

Undocumented
fiftyone.factory.repo_factory.RepositoryFactory.execution_store_repo

fiftyone.factory.repo_factory.RepositoryFactory.html#execution_store_repo

Function

Static Method

PUBLIC

Undocumented
fiftyone.migrations.runner.logger

fiftyone.migrations.runner.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.migrations.runner.DOWN

fiftyone.migrations.runner.html#DOWN

Attribute

Constant

PUBLIC

Undocumented
fiftyone.migrations.runner.UP

fiftyone.migrations.runner.html#UP

Attribute

Constant

PUBLIC

Undocumented
fiftyone.migrations.runner.Version

fiftyone.migrations.runner.html#Version

Function

Function

PUBLIC

A packaging.version.Version proxy that excludes things like RC version info.
fiftyone.migrations.runner._migrations_disabled

fiftyone.migrations.runner.html#_migrations_disabled

Function

Function

PRIVATE

Undocumented
fiftyone.migrations.runner.get_database_revision

fiftyone.migrations.runner.html#get_database_revision

Function

Function

PUBLIC

Gets the current revision of the database.
fiftyone.migrations.runner.get_dataset_revision

fiftyone.migrations.runner.html#get_dataset_revision

Function

Function

PUBLIC

Gets the current revision of the given dataset.
fiftyone.migrations.runner.migrate_all

fiftyone.migrations.runner.html#migrate_all

Function

Function

PUBLIC

Migrates the database and all datasets to the specified destination revision.
fiftyone.migrations.runner.migrate_database_if_necessary

fiftyone.migrations.runner.html#migrate_database_if_necessary

Function

Function

PUBLIC

Migrates the database to the specified revision, if necessary.
fiftyone.migrations.runner.needs_migration

fiftyone.migrations.runner.html#needs_migration

Function

Function

PUBLIC

Determines whether a dataset requires a migration in order to be used in the specified destination revision.
fiftyone.migrations.runner.migrate_dataset_if_necessary

fiftyone.migrations.runner.html#migrate_dataset_if_necessary

Function

Function

PUBLIC

Migrates the dataset from its current revision to the specified destination revision.
fiftyone.migrations.runner._migrate_dataset_if_necessary

fiftyone.migrations.runner.html#_migrate_dataset_if_necessary

Function

Function

PRIVATE

Undocumented
fiftyone.migrations.runner.MigrationRunner

fiftyone.migrations.runner.MigrationRunner.html

Class

Class

PUBLIC

Class for running FiftyOne migrations.
fiftyone.migrations.runner.MigrationRunner.__init__

fiftyone.migrations.runner.MigrationRunner.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.migrations.runner.MigrationRunner._head

fiftyone.migrations.runner.MigrationRunner.html#_head

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.migrations.runner.MigrationRunner._destination

fiftyone.migrations.runner.MigrationRunner.html#_destination

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.migrations.runner.MigrationRunner._revisions

fiftyone.migrations.runner.MigrationRunner.html#_revisions

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.migrations.runner.MigrationRunner._direction

fiftyone.migrations.runner.MigrationRunner.html#_direction

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.migrations.runner.MigrationRunner._admin_revisions

fiftyone.migrations.runner.MigrationRunner.html#_admin_revisions

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.migrations.runner.MigrationRunner.head

fiftyone.migrations.runner.MigrationRunner.html#head

Attribute

Property

PUBLIC

The head revision.
fiftyone.migrations.runner.MigrationRunner.destination

fiftyone.migrations.runner.MigrationRunner.html#destination

Attribute

Property

PUBLIC

The destination revision.
fiftyone.migrations.runner.MigrationRunner.direction

fiftyone.migrations.runner.MigrationRunner.html#direction

Attribute

Property

PUBLIC

The direction of the migration runner; one of ("up", "down").
fiftyone.migrations.runner.MigrationRunner.has_revisions

fiftyone.migrations.runner.MigrationRunner.html#has_revisions

Attribute

Property

PUBLIC

Whether there are any revisions to run.
fiftyone.migrations.runner.MigrationRunner.has_admin_revisions

fiftyone.migrations.runner.MigrationRunner.html#has_admin_revisions

Attribute

Property

PUBLIC

Whether there are any admin revisions to run.
fiftyone.migrations.runner.MigrationRunner.revisions

fiftyone.migrations.runner.MigrationRunner.html#revisions

Attribute

Property

PUBLIC

The list of revisions that will be run by run.
fiftyone.migrations.runner.MigrationRunner.admin_revisions

fiftyone.migrations.runner.MigrationRunner.html#admin_revisions

Attribute

Property

PUBLIC

The list of admin revisions that will be run by run_admin.
fiftyone.migrations.runner.MigrationRunner.run

fiftyone.migrations.runner.MigrationRunner.html#run

Function

Method

PUBLIC

Runs any required migrations on the specified dataset.
fiftyone.migrations.runner.MigrationRunner.run_admin

fiftyone.migrations.runner.MigrationRunner.html#run_admin

Function

Method

PUBLIC

Runs any required admin revisions.
fiftyone.migrations.runner._database_exists

fiftyone.migrations.runner.html#_database_exists

Function

Function

PRIVATE

Undocumented
fiftyone.migrations.runner._is_compatible_version

fiftyone.migrations.runner.html#_is_compatible_version

Function

Function

PRIVATE

Undocumented
fiftyone.migrations.runner._can_skip_migration

fiftyone.migrations.runner.html#_can_skip_migration

Function

Function

PRIVATE

Undocumented
fiftyone.migrations.runner._get_revisions_to_run

fiftyone.migrations.runner.html#_get_revisions_to_run

Function

Function

PRIVATE

Undocumented
fiftyone.migrations.runner._get_all_revisions

fiftyone.migrations.runner.html#_get_all_revisions

Function

Function

PRIVATE

Undocumented
fiftyone.operators.evaluation_metric.EvaluationMetricConfig

fiftyone.operators.evaluation_metric.EvaluationMetricConfig.html

Class

Class

PUBLIC

Configuration class for evaluation metrics.
fiftyone.operators.evaluation_metric.EvaluationMetricConfig.eval_types

fiftyone.operators.evaluation_metric.EvaluationMetricConfig.html#eval_types

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.evaluation_metric.EvaluationMetricConfig.aggregate_key

fiftyone.operators.evaluation_metric.EvaluationMetricConfig.html#aggregate_key

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.evaluation_metric.EvaluationMetricConfig.lower_is_better

fiftyone.operators.evaluation_metric.EvaluationMetricConfig.html#lower_is_better

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.evaluation_metric.EvaluationMetricConfig.__init__

fiftyone.operators.evaluation_metric.EvaluationMetricConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.evaluation_metric.EvaluationMetric

fiftyone.operators.evaluation_metric.EvaluationMetric.html

Class

Class

PUBLIC

Base class for evaluation metric operators.
fiftyone.operators.evaluation_metric.EvaluationMetric.get_parameters

fiftyone.operators.evaluation_metric.EvaluationMetric.html#get_parameters

Function

Method

PUBLIC

Defines any necessary properties to collect this evaluation metric's parameters from a user during prompting.
fiftyone.operators.evaluation_metric.EvaluationMetric.parse_parameters

fiftyone.operators.evaluation_metric.EvaluationMetric.html#parse_parameters

Function

Method

PUBLIC

Performs any necessary execution-time formatting to this evaluation metric's parameters.
fiftyone.operators.evaluation_metric.EvaluationMetric.compute

fiftyone.operators.evaluation_metric.EvaluationMetric.html#compute

Function

Method

PUBLIC

Computes the evaluation metric for the given collection.
fiftyone.operators.evaluation_metric.EvaluationMetric.get_fields

fiftyone.operators.evaluation_metric.EvaluationMetric.html#get_fields

Function

Method

PUBLIC

Lists the fields that were populated by the evaluation metric with the given key, if any.
fiftyone.operators.evaluation_metric.EvaluationMetric.rename

fiftyone.operators.evaluation_metric.EvaluationMetric.html#rename

Function

Method

PUBLIC

Performs any necessary operations required to rename this evaluation metric's key.
fiftyone.operators.evaluation_metric.EvaluationMetric.cleanup

fiftyone.operators.evaluation_metric.EvaluationMetric.html#cleanup

Function

Method

PUBLIC

Cleans up the results of the evaluation metric with the given key from the collection.
fiftyone.operators.utils.ProgressHandler

fiftyone.operators.utils.ProgressHandler.html

Class

Class

PUBLIC

A logging handler that reports all logging messages issued while the handler's context manager is active to the provided execution context's set_progress()...
fiftyone.operators.utils.ProgressHandler.logger

fiftyone.operators.utils.ProgressHandler.html#logger

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.utils.ProgressHandler.level

fiftyone.operators.utils.ProgressHandler.html#level

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.utils.ProgressHandler.__init__

fiftyone.operators.utils.ProgressHandler.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.utils.ProgressHandler.ctx

fiftyone.operators.utils.ProgressHandler.html#ctx

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.utils.ProgressHandler.__enter__

fiftyone.operators.utils.ProgressHandler.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.utils.ProgressHandler.__exit__

fiftyone.operators.utils.ProgressHandler.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.utils.ProgressHandler.emit

fiftyone.operators.utils.ProgressHandler.html#emit

Function

Method

PUBLIC

Undocumented
fiftyone.operators.utils.is_method_overridden

fiftyone.operators.utils.html#is_method_overridden

Function

Function

PUBLIC

Returns whether a method is overridden in a subclass.
fiftyone.operators.utils.is_new

fiftyone.operators.utils.html#is_new

Function

Function

PUBLIC

Determines if a feature is considered "new" based on its release date.
fiftyone.operators.delegated.logger

fiftyone.operators.delegated.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.operators.delegated.DelegatedOperationService

fiftyone.operators.delegated.DelegatedOperationService.html

Class

Class

PUBLIC

Service for executing delegated operations.
fiftyone.operators.delegated.DelegatedOperationService.__init__

fiftyone.operators.delegated.DelegatedOperationService.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.delegated.DelegatedOperationService._repo

fiftyone.operators.delegated.DelegatedOperationService.html#_repo

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.operators.delegated.DelegatedOperationService.queue_operation

fiftyone.operators.delegated.DelegatedOperationService.html#queue_operation

Function

Method

PUBLIC

Queues the given delegated operation for execution.
fiftyone.operators.delegated.DelegatedOperationService.set_progress

fiftyone.operators.delegated.DelegatedOperationService.html#set_progress

Function

Method

PUBLIC

Sets the progress of the given delegated operation.
fiftyone.operators.delegated.DelegatedOperationService.set_running

fiftyone.operators.delegated.DelegatedOperationService.html#set_running

Function

Method

PUBLIC

Sets the given delegated operation to running state.
fiftyone.operators.delegated.DelegatedOperationService.set_scheduled

fiftyone.operators.delegated.DelegatedOperationService.html#set_scheduled

Function

Method

PUBLIC

Sets the given delegated operation to scheduled state.
fiftyone.operators.delegated.DelegatedOperationService.set_queued

fiftyone.operators.delegated.DelegatedOperationService.html#set_queued

Function

Method

PUBLIC

Sets the given delegated operation to queued state.
fiftyone.operators.delegated.DelegatedOperationService.set_completed

fiftyone.operators.delegated.DelegatedOperationService.html#set_completed

Function

Method

PUBLIC

Sets the given delegated operation to completed state.
fiftyone.operators.delegated.DelegatedOperationService.set_failed

fiftyone.operators.delegated.DelegatedOperationService.html#set_failed

Function

Method

PUBLIC

Sets the given delegated operation to failed state.
fiftyone.operators.delegated.DelegatedOperationService.set_pinned

fiftyone.operators.delegated.DelegatedOperationService.html#set_pinned

Function

Method

PUBLIC

Sets the pinned flag for the given delegated operation.
fiftyone.operators.delegated.DelegatedOperationService.set_label

fiftyone.operators.delegated.DelegatedOperationService.html#set_label

Function

Method

PUBLIC

Sets the pinned flag for the given delegated operation.
fiftyone.operators.delegated.DelegatedOperationService.delete_operation

fiftyone.operators.delegated.DelegatedOperationService.html#delete_operation

Function

Method

PUBLIC

Deletes the given delegated operation.
fiftyone.operators.delegated.DelegatedOperationService.delete_for_dataset

fiftyone.operators.delegated.DelegatedOperationService.html#delete_for_dataset

Function

Method

PUBLIC

Deletes all delegated operations associated with the given dataset.
fiftyone.operators.delegated.DelegatedOperationService.rerun_operation

fiftyone.operators.delegated.DelegatedOperationService.html#rerun_operation

Function

Method

PUBLIC

Reruns the specified delegated operation.
fiftyone.operators.delegated.DelegatedOperationService.get_queued_operations

fiftyone.operators.delegated.DelegatedOperationService.html#get_queued_operations

Function

Method

PUBLIC

Returns all queued delegated operations.
fiftyone.operators.delegated.DelegatedOperationService.get_scheduled_operations

fiftyone.operators.delegated.DelegatedOperationService.html#get_scheduled_operations

Function

Method

PUBLIC

Returns all scheduled delegated operations.
fiftyone.operators.delegated.DelegatedOperationService.get_running_operations

fiftyone.operators.delegated.DelegatedOperationService.html#get_running_operations

Function

Method

PUBLIC

Returns all running delegated operations.
fiftyone.operators.delegated.DelegatedOperationService.get

fiftyone.operators.delegated.DelegatedOperationService.html#get

Function

Method

PUBLIC

Returns the delegated operation with the given ID.
fiftyone.operators.delegated.DelegatedOperationService.list_operations

fiftyone.operators.delegated.DelegatedOperationService.html#list_operations

Function

Method

PUBLIC

Lists the delegated operations matching the given criteria.
fiftyone.operators.delegated.DelegatedOperationService.execute_queued_operations

fiftyone.operators.delegated.DelegatedOperationService.html#execute_queued_operations

Function

Method

PUBLIC

Executes queued delegated operations matching the given criteria.
fiftyone.operators.delegated.DelegatedOperationService.count

fiftyone.operators.delegated.DelegatedOperationService.html#count

Function

Method

PUBLIC

Counts the delegated operations matching the given criteria.
fiftyone.operators.delegated.DelegatedOperationService.execute_operation

fiftyone.operators.delegated.DelegatedOperationService.html#execute_operation

Function

Method

PUBLIC

Executes the given delegated operation.
fiftyone.operators.delegated.DelegatedOperationService._execute_operator

fiftyone.operators.delegated.DelegatedOperationService.html#_execute_operator

Function

Method

PRIVATE

Undocumented
fiftyone.operators.permissions.ManagedOperators

fiftyone.operators.permissions.ManagedOperators.html

Class

Class

PUBLIC

Undocumented
fiftyone.operators.permissions.ManagedOperators.__init__

fiftyone.operators.permissions.ManagedOperators.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.permissions.ManagedOperators.managed_operators

fiftyone.operators.permissions.ManagedOperators.html#managed_operators

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.permissions.ManagedOperators.has_operator

fiftyone.operators.permissions.ManagedOperators.html#has_operator

Function

Method

PUBLIC

Undocumented
fiftyone.operators.permissions.ManagedOperators.for_request

fiftyone.operators.permissions.ManagedOperators.html#for_request

Function

Class Method

PUBLIC

Undocumented
fiftyone.operators.permissions.PermissionedOperatorRegistry

fiftyone.operators.permissions.PermissionedOperatorRegistry.html

Class

Class

PUBLIC

Undocumented
fiftyone.operators.permissions.PermissionedOperatorRegistry.__init__

fiftyone.operators.permissions.PermissionedOperatorRegistry.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.operators.permissions.PermissionedOperatorRegistry.managed_operators

fiftyone.operators.permissions.PermissionedOperatorRegistry.html#managed_operators

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.operators.permissions.PermissionedOperatorRegistry.can_execute

fiftyone.operators.permissions.PermissionedOperatorRegistry.html#can_execute

Function

Method

PUBLIC

Whether the operator can be executed.
fiftyone.operators.permissions.PermissionedOperatorRegistry.from_list_request

fiftyone.operators.permissions.PermissionedOperatorRegistry.html#from_list_request

Function

Class Method

PUBLIC

Undocumented
fiftyone.operators.permissions.PermissionedOperatorRegistry.from_exec_request

fiftyone.operators.permissions.PermissionedOperatorRegistry.html#from_exec_request

Function

Class Method

PUBLIC

Undocumented
fiftyone.server.decorators.Encoder

fiftyone.server.decorators.Encoder.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.decorators.Encoder.default

fiftyone.server.decorators.Encoder.html#default

Function

Method

PUBLIC

Undocumented
fiftyone.server.decorators.create_response

fiftyone.server.decorators.html#create_response

Function

Function

PUBLIC

Undocumented
fiftyone.server.decorators.route

fiftyone.server.decorators.html#route

Function

Function

PUBLIC

Undocumented
fiftyone.operators.server.get_operators

fiftyone.operators.server.html#get_operators

Function

Function

PUBLIC

Undocumented
fiftyone.operators.server.ListOperators

fiftyone.operators.server.ListOperators.html

Class

Class

PUBLIC

Undocumented
fiftyone.operators.server.ListOperators.post

fiftyone.operators.server.ListOperators.html#post

Function

Method

PUBLIC

Undocumented
fiftyone.operators.server.ResolvePlacements

fiftyone.operators.server.ResolvePlacements.html

Class

Class

PUBLIC

Undocumented
fiftyone.operators.server.ResolvePlacements.post

fiftyone.operators.server.ResolvePlacements.html#post

Function

Method

PUBLIC

Undocumented
fiftyone.operators.server.ExecuteOperator

fiftyone.operators.server.ExecuteOperator.html

Class

Class

PUBLIC

Undocumented
fiftyone.operators.server.ExecuteOperator.post

fiftyone.operators.server.ExecuteOperator.html#post

Function

Method

PUBLIC

Undocumented
fiftyone.operators.server.create_response_generator

fiftyone.operators.server.html#create_response_generator

Function

Function

PUBLIC

Undocumented
fiftyone.operators.server.create_response_async_generator

fiftyone.operators.server.html#create_response_async_generator

Function

Function

PUBLIC

Undocumented
fiftyone.operators.server.create_permission_error

fiftyone.operators.server.html#create_permission_error

Function

Function

PUBLIC

Undocumented
fiftyone.operators.server.ExecuteOperatorAsGenerator

fiftyone.operators.server.ExecuteOperatorAsGenerator.html

Class

Class

PUBLIC

Undocumented
fiftyone.operators.server.ExecuteOperatorAsGenerator.post

fiftyone.operators.server.ExecuteOperatorAsGenerator.html#post

Function

Method

PUBLIC

Undocumented
fiftyone.operators.server.ResolveType

fiftyone.operators.server.ResolveType.html

Class

Class

PUBLIC

Undocumented
fiftyone.operators.server.ResolveType.post

fiftyone.operators.server.ResolveType.html#post

Function

Method

PUBLIC

Undocumented
fiftyone.operators.server.ResolveExecutionOptions

fiftyone.operators.server.ResolveExecutionOptions.html

Class

Class

PUBLIC

Undocumented
fiftyone.operators.server.ResolveExecutionOptions.post

fiftyone.operators.server.ResolveExecutionOptions.html#post

Function

Method

PUBLIC

Undocumented
fiftyone.operators.server.OperatorRoutes

fiftyone.operators.server.html#OperatorRoutes

Attribute

Variable

PUBLIC

Undocumented
fiftyone.plugins.context.logger

fiftyone.plugins.context.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.plugins.context.INIT_FILENAME

fiftyone.plugins.context.html#INIT_FILENAME

Attribute

Constant

PUBLIC

Undocumented
fiftyone.plugins.context.build_plugin_contexts

fiftyone.plugins.context.html#build_plugin_contexts

Function

Function

PUBLIC

Returns contexts for all available plugins.
fiftyone.plugins.context.PluginContext

fiftyone.plugins.context.PluginContext.html

Class

Class

PUBLIC

Context that represents a plugin and the Python objects it creates.
fiftyone.plugins.context.PluginContext.__init__

fiftyone.plugins.context.PluginContext.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.plugins.context.PluginContext.plugin_definition

fiftyone.plugins.context.PluginContext.html#plugin_definition

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.plugins.context.PluginContext.instances

fiftyone.plugins.context.PluginContext.html#instances

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.plugins.context.PluginContext.errors

fiftyone.plugins.context.PluginContext.html#errors

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.plugins.context.PluginContext.name

fiftyone.plugins.context.PluginContext.html#name

Attribute

Property

PUBLIC

The plugin name.
fiftyone.plugins.context.PluginContext.secrets

fiftyone.plugins.context.PluginContext.html#secrets

Attribute

Property

PUBLIC

List of keys for required secrets as specified in the plugin definition.
fiftyone.plugins.context.PluginContext.has_errors

fiftyone.plugins.context.PluginContext.html#has_errors

Function

Method

PUBLIC

Determines whether the plugin has errors.
fiftyone.plugins.context.PluginContext.can_register

fiftyone.plugins.context.PluginContext.html#can_register

Function

Method

PUBLIC

Determines whether the given operator can be registered.
fiftyone.plugins.context.PluginContext.register

fiftyone.plugins.context.PluginContext.html#register

Function

Method

PUBLIC

Registers the given operator on the plugin.
fiftyone.plugins.context.PluginContext.register_all

fiftyone.plugins.context.PluginContext.html#register_all

Function

Method

PUBLIC

Registers all operators defined by the plugin on this context.
fiftyone.plugins.context.PluginContext.dispose_all

fiftyone.plugins.context.PluginContext.html#dispose_all

Function

Method

PUBLIC

Disposes all operators from this context.
fiftyone.plugins.constants.BUILTIN_PLUGINS_DIR

fiftyone.plugins.constants.html#BUILTIN_PLUGINS_DIR

Attribute

Constant

PUBLIC

Undocumented
fiftyone.plugins.utils.logger

fiftyone.plugins.utils.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.plugins.utils.list_zoo_plugins

fiftyone.plugins.utils.html#list_zoo_plugins

Function

Function

PUBLIC

Returns a list of available plugins registered in the FiftyOne Plugins repository README.
fiftyone.plugins.utils.find_plugins

fiftyone.plugins.utils.html#find_plugins

Function

Function

PUBLIC

Returns the paths to the fiftyone YAML files for all plugins found in the given GitHub repository.
fiftyone.plugins.utils.get_plugin_info

fiftyone.plugins.utils.html#get_plugin_info

Function

Function

PUBLIC

Returns a dict of plugin info for a FiftyOne plugin hosted in GitHub.
fiftyone.plugins.utils._get_all_plugin_info

fiftyone.plugins.utils.html#_get_all_plugin_info

Function

Function

PRIVATE

Undocumented
fiftyone.plugins.utils._do_get_plugin_info

fiftyone.plugins.utils.html#_do_get_plugin_info

Function

Function

PRIVATE

Undocumented
fiftyone.server.constants.LIST_LIMIT

fiftyone.server.constants.html#LIST_LIMIT

Attribute

Constant

PUBLIC

Undocumented
fiftyone.server.constants.SCALAR_OVERRIDES

fiftyone.server.constants.html#SCALAR_OVERRIDES

Attribute

Constant

PUBLIC

Undocumented
fiftyone.server.data.T

fiftyone.server.data.html#T

Attribute

Type Variable

PUBLIC

Undocumented
fiftyone.server.data.Context

fiftyone.server.data.Context.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.data.Context.db

fiftyone.server.data.Context.html#db

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.data.Context.dataloaders

fiftyone.server.data.Context.html#dataloaders

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.data.Context.request

fiftyone.server.data.Context.html#request

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.data.Context.response

fiftyone.server.data.Context.html#response

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.data.Info

fiftyone.server.data.html#Info

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.filters.OneOf

fiftyone.server.filters.OneOf.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.filters.GroupElementFilter

fiftyone.server.filters.GroupElementFilter.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.filters.GroupElementFilter.id

fiftyone.server.filters.GroupElementFilter.html#id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.filters.GroupElementFilter.slice

fiftyone.server.filters.GroupElementFilter.html#slice

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.filters.GroupElementFilter.slices

fiftyone.server.filters.GroupElementFilter.html#slices

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.filters.SampleFilter

fiftyone.server.filters.SampleFilter.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.filters.SampleFilter.id

fiftyone.server.filters.SampleFilter.html#id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.filters.SampleFilter.group

fiftyone.server.filters.SampleFilter.html#group

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.view._LABEL_TAGS

fiftyone.server.view.html#_LABEL_TAGS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.server.view.ExtendedViewForm

fiftyone.server.view.ExtendedViewForm.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.view.ExtendedViewForm.filters

fiftyone.server.view.ExtendedViewForm.html#filters

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.view.ExtendedViewForm.mixed

fiftyone.server.view.ExtendedViewForm.html#mixed

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.view.ExtendedViewForm.sample_ids

fiftyone.server.view.ExtendedViewForm.html#sample_ids

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.view.ExtendedViewForm.slice

fiftyone.server.view.ExtendedViewForm.html#slice

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.view.load_view

fiftyone.server.view.html#load_view

Function

Function

PUBLIC

Undocumented
fiftyone.server.view.get_view

fiftyone.server.view.html#get_view

Function

Function

PUBLIC

Gets the view defined by the given request parameters.
fiftyone.server.view.get_extended_view

fiftyone.server.view.html#get_extended_view

Function

Function

PUBLIC

Create an extended view with the provided filters.
fiftyone.server.view.extend_view

fiftyone.server.view.html#extend_view

Function

Function

PUBLIC

Adds the given extended stages to the view.
fiftyone.server.view.handle_group_filter

fiftyone.server.view.html#handle_group_filter

Function

Function

PUBLIC

Handle a group filter for App view requests.
fiftyone.server.view._add_labels_tags_counts

fiftyone.server.view.html#_add_labels_tags_counts

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._project_pagination_paths

fiftyone.server.view.html#_project_pagination_paths

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._make_match_stage

fiftyone.server.view.html#_make_match_stage

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._make_field_filter_stages

fiftyone.server.view.html#_make_field_filter_stages

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._make_label_filter_stages

fiftyone.server.view.html#_make_label_filter_stages

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._iter_paths

fiftyone.server.view.html#_iter_paths

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._is_support

fiftyone.server.view.html#_is_support

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._is_datetime

fiftyone.server.view.html#_is_datetime

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._is_label_type

fiftyone.server.view.html#_is_label_type

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._make_query

fiftyone.server.view.html#_make_query

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._NONFINITES

fiftyone.server.view.html#_NONFINITES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.server.view._make_range_query

fiftyone.server.view.html#_make_range_query

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._make_scalar_expression

fiftyone.server.view.html#_make_scalar_expression

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._make_keypoint_list_filter

fiftyone.server.view.html#_make_keypoint_list_filter

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._apply_others

fiftyone.server.view.html#_apply_others

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._apply_none

fiftyone.server.view.html#_apply_none

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._add_frame_labels_tags

fiftyone.server.view.html#_add_frame_labels_tags

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._add_frame_label_tags

fiftyone.server.view.html#_add_frame_label_tags

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._add_labels_tags

fiftyone.server.view.html#_add_labels_tags

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._add_label_tags

fiftyone.server.view.html#_add_label_tags

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._count_list_items

fiftyone.server.view.html#_count_list_items

Function

Function

PRIVATE

Undocumented
fiftyone.server.view._match_label_tags

fiftyone.server.view.html#_match_label_tags

Function

Function

PRIVATE

Undocumented
fiftyone.server.aggregate._DEFAULT_NUM_HISTOGRAM_BINS

fiftyone.server.aggregate.html#_DEFAULT_NUM_HISTOGRAM_BINS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.server.aggregate.CountResponse

fiftyone.server.aggregate.CountResponse.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregate.CountResponse.count

fiftyone.server.aggregate.CountResponse.html#count

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.ValueCount

fiftyone.server.aggregate.ValueCount.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregate.ValueCount.key

fiftyone.server.aggregate.ValueCount.html#key

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.ValueCount.value

fiftyone.server.aggregate.ValueCount.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.CountValuesResponse

fiftyone.server.aggregate.CountValuesResponse.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregate.CountValuesResponse.values

fiftyone.server.aggregate.CountValuesResponse.html#values

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.BoolCountValuesResponse

fiftyone.server.aggregate.BoolCountValuesResponse.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregate.BoolCountValuesResponse.values

fiftyone.server.aggregate.BoolCountValuesResponse.html#values

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.IntCountValuesResponse

fiftyone.server.aggregate.IntCountValuesResponse.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregate.IntCountValuesResponse.values

fiftyone.server.aggregate.IntCountValuesResponse.html#values

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.StrCountValuesResponse

fiftyone.server.aggregate.StrCountValuesResponse.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregate.StrCountValuesResponse.values

fiftyone.server.aggregate.StrCountValuesResponse.html#values

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.CountValuesResponses

fiftyone.server.aggregate.html#CountValuesResponses

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.COUNT_VALUES_TYPES

fiftyone.server.aggregate.html#COUNT_VALUES_TYPES

Attribute

Constant

PUBLIC

Undocumented
fiftyone.server.aggregate.HistogramValuesResponse

fiftyone.server.aggregate.HistogramValuesResponse.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregate.HistogramValuesResponse.counts

fiftyone.server.aggregate.HistogramValuesResponse.html#counts

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.HistogramValuesResponse.edges

fiftyone.server.aggregate.HistogramValuesResponse.html#edges

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.HistogramValuesResponse.other

fiftyone.server.aggregate.HistogramValuesResponse.html#other

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.DatetimeHistogramValuesResponse

fiftyone.server.aggregate.DatetimeHistogramValuesResponse.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregate.DatetimeHistogramValuesResponse.edges

fiftyone.server.aggregate.DatetimeHistogramValuesResponse.html#edges

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.FloatHistogramValuesResponse

fiftyone.server.aggregate.FloatHistogramValuesResponse.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregate.FloatHistogramValuesResponse.edges

fiftyone.server.aggregate.FloatHistogramValuesResponse.html#edges

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.IntHistogramValuesResponse

fiftyone.server.aggregate.IntHistogramValuesResponse.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregate.IntHistogramValuesResponse.edges

fiftyone.server.aggregate.IntHistogramValuesResponse.html#edges

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.Count

fiftyone.server.aggregate.Count.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregate.Count.field

fiftyone.server.aggregate.Count.html#field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.CountValues

fiftyone.server.aggregate.CountValues.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregate.CountValues.field

fiftyone.server.aggregate.CountValues.html#field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.HistogramValues

fiftyone.server.aggregate.HistogramValues.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregate.HistogramValues.field

fiftyone.server.aggregate.HistogramValues.html#field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.Aggregate

fiftyone.server.aggregate.Aggregate.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregate.Aggregate.count

fiftyone.server.aggregate.Aggregate.html#count

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.Aggregate.count_values

fiftyone.server.aggregate.Aggregate.html#count_values

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.Aggregate.histogram_values

fiftyone.server.aggregate.Aggregate.html#histogram_values

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.HistogramValuesResponses

fiftyone.server.aggregate.html#HistogramValuesResponses

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.aggregate.HISTOGRAM_VALUES_TYPES

fiftyone.server.aggregate.html#HISTOGRAM_VALUES_TYPES

Attribute

Constant

PUBLIC

Undocumented
fiftyone.server.aggregate.AggregateQuery

fiftyone.server.aggregate.AggregateQuery.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregate.AggregateQuery.aggregate

fiftyone.server.aggregate.AggregateQuery.html#aggregate

Function

Method

PUBLIC

Undocumented
fiftyone.server.aggregate._count

fiftyone.server.aggregate.html#_count

Function

Function

PRIVATE

Undocumented
fiftyone.server.aggregate._count_values

fiftyone.server.aggregate.html#_count_values

Function

Function

PRIVATE

Undocumented
fiftyone.server.aggregate._histogram_values

fiftyone.server.aggregate.html#_histogram_values

Function

Function

PRIVATE

Undocumented
fiftyone.server.inputs.SelectedLabel

fiftyone.server.inputs.SelectedLabel.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.inputs.SelectedLabel.label_id

fiftyone.server.inputs.SelectedLabel.html#label_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.inputs.SelectedLabel.field

fiftyone.server.inputs.SelectedLabel.html#field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.inputs.SelectedLabel.sample_id

fiftyone.server.inputs.SelectedLabel.html#sample_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.inputs.SelectedLabel.frame_number

fiftyone.server.inputs.SelectedLabel.html#frame_number

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.utils._cache

fiftyone.server.utils.html#_cache

Attribute

Variable

PRIVATE

Undocumented
fiftyone.server.utils._dacite_config

fiftyone.server.utils.html#_dacite_config

Attribute

Variable

PRIVATE

Undocumented
fiftyone.server.utils.load_and_cache_dataset

fiftyone.server.utils.html#load_and_cache_dataset

Function

Function

PUBLIC

Loads the dataset with the given name and caches it.
fiftyone.server.utils.cache_dataset

fiftyone.server.utils.html#cache_dataset

Function

Function

PUBLIC

Caches the given dataset.
fiftyone.server.utils.change_sample_tags

fiftyone.server.utils.html#change_sample_tags

Function

Function

PUBLIC

Applies the changes to tags to all samples of the collection, if necessary.
fiftyone.server.utils.change_label_tags

fiftyone.server.utils.html#change_label_tags

Function

Function

PUBLIC

Applies the changes to tags to all labels in the specified label field(s) of the collection, if necessary.
fiftyone.server.utils.from_dict

fiftyone.server.utils.html#from_dict

Function

Function

PUBLIC

Wrapping function for dacite.from_dict that ensures a common configuration is used.
fiftyone.server.utils.meets_type

fiftyone.server.utils.html#meets_type

Function

Function

PUBLIC

Determines whether the field meets type or types, or the field is a fiftyone.core.fields.ListField that meets the type or types
fiftyone.server.utils._parse_changes

fiftyone.server.utils.html#_parse_changes

Function

Function

PRIVATE

Undocumented
fiftyone.server.aggregations.AggregationForm

fiftyone.server.aggregations.AggregationForm.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregations.AggregationForm.dataset

fiftyone.server.aggregations.AggregationForm.html#dataset

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.AggregationForm.extended_stages

fiftyone.server.aggregations.AggregationForm.html#extended_stages

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.AggregationForm.filters

fiftyone.server.aggregations.AggregationForm.html#filters

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.AggregationForm.group_id

fiftyone.server.aggregations.AggregationForm.html#group_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.AggregationForm.hidden_labels

fiftyone.server.aggregations.AggregationForm.html#hidden_labels

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.AggregationForm.index

fiftyone.server.aggregations.AggregationForm.html#index

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.AggregationForm.mixed

fiftyone.server.aggregations.AggregationForm.html#mixed

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.AggregationForm.paths

fiftyone.server.aggregations.AggregationForm.html#paths

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.AggregationForm.sample_ids

fiftyone.server.aggregations.AggregationForm.html#sample_ids

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.AggregationForm.slice

fiftyone.server.aggregations.AggregationForm.html#slice

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.AggregationForm.slices

fiftyone.server.aggregations.AggregationForm.html#slices

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.AggregationForm.view

fiftyone.server.aggregations.AggregationForm.html#view

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.AggregationForm.view_name

fiftyone.server.aggregations.AggregationForm.html#view_name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.Aggregation

fiftyone.server.aggregations.Aggregation.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregations.Aggregation.path

fiftyone.server.aggregations.Aggregation.html#path

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.Aggregation.count

fiftyone.server.aggregations.Aggregation.html#count

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.Aggregation.exists

fiftyone.server.aggregations.Aggregation.html#exists

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.BooleanAggregation

fiftyone.server.aggregations.BooleanAggregation.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregations.BooleanAggregation.false

fiftyone.server.aggregations.BooleanAggregation.html#false

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.BooleanAggregation.true

fiftyone.server.aggregations.BooleanAggregation.html#true

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.DataAggregation

fiftyone.server.aggregations.DataAggregation.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregations.IntAggregation

fiftyone.server.aggregations.IntAggregation.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregations.IntAggregation.max

fiftyone.server.aggregations.IntAggregation.html#max

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.IntAggregation.min

fiftyone.server.aggregations.IntAggregation.html#min

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.FloatAggregation

fiftyone.server.aggregations.FloatAggregation.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregations.FloatAggregation.inf

fiftyone.server.aggregations.FloatAggregation.html#inf

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.FloatAggregation.max

fiftyone.server.aggregations.FloatAggregation.html#max

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.FloatAggregation.min

fiftyone.server.aggregations.FloatAggregation.html#min

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.FloatAggregation.nan

fiftyone.server.aggregations.FloatAggregation.html#nan

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.FloatAggregation.ninf

fiftyone.server.aggregations.FloatAggregation.html#ninf

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.RootAggregation

fiftyone.server.aggregations.RootAggregation.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregations.RootAggregation.slice

fiftyone.server.aggregations.RootAggregation.html#slice

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.RootAggregation.expanded_field_count

fiftyone.server.aggregations.RootAggregation.html#expanded_field_count

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.RootAggregation.frame_label_field_count

fiftyone.server.aggregations.RootAggregation.html#frame_label_field_count

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.StringAggregationValue

fiftyone.server.aggregations.StringAggregationValue.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregations.StringAggregationValue.count

fiftyone.server.aggregations.StringAggregationValue.html#count

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.StringAggregationValue.value

fiftyone.server.aggregations.StringAggregationValue.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.StringAggregation

fiftyone.server.aggregations.StringAggregation.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.aggregations.StringAggregation.values

fiftyone.server.aggregations.StringAggregation.html#values

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.AggregateResult

fiftyone.server.aggregations.html#AggregateResult

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.aggregations.aggregate_resolver

fiftyone.server.aggregations.html#aggregate_resolver

Function

Function

PUBLIC

Undocumented
fiftyone.server.aggregations.RESULT_MAPPING

fiftyone.server.aggregations.html#RESULT_MAPPING

Attribute

Constant

PUBLIC

Undocumented
fiftyone.server.aggregations._load_view

fiftyone.server.aggregations.html#_load_view

Function

Function

PRIVATE

Undocumented
fiftyone.server.aggregations._resolve_path_aggregation

fiftyone.server.aggregations.html#_resolve_path_aggregation

Function

Function

PRIVATE

Undocumented
fiftyone.server.aggregations._CountExists

fiftyone.server.aggregations._CountExists.html

Class

Class

PRIVATE

Named helper aggregation for counting existence
fiftyone.server.aggregations._CountExists.__init__

fiftyone.server.aggregations._CountExists.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.server.aggregations._count_expanded_fields

fiftyone.server.aggregations.html#_count_expanded_fields

Function

Function

PRIVATE

Undocumented
fiftyone.server.dataloader.DataLoaderConfig

fiftyone.server.dataloader.DataLoaderConfig.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.dataloader.DataLoaderConfig.collection

fiftyone.server.dataloader.DataLoaderConfig.html#collection

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.dataloader.DataLoaderConfig.key

fiftyone.server.dataloader.DataLoaderConfig.html#key

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.dataloader.DataLoaderConfig.filters

fiftyone.server.dataloader.DataLoaderConfig.html#filters

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.dataloader.DataLoaderConfig.projections

fiftyone.server.dataloader.DataLoaderConfig.html#projections

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.dataloader.dataloaders

fiftyone.server.dataloader.html#dataloaders

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.dataloader.get_dataloader

fiftyone.server.dataloader.html#get_dataloader

Function

Function

PUBLIC

Undocumented
fiftyone.server.dataloader.get_dataloader_resolver

fiftyone.server.dataloader.html#get_dataloader_resolver

Function

Function

PUBLIC

Undocumented
fiftyone.server.context.get_context

fiftyone.server.context.html#get_context

Function

Function

PUBLIC

Undocumented
fiftyone.server.context.GraphQL

fiftyone.server.context.GraphQL.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.context.GraphQL.get_context

fiftyone.server.context.GraphQL.html#get_context

Function

Method

PUBLIC

Undocumented
fiftyone.server.extensions.EndSession

fiftyone.server.extensions.EndSession.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.extensions.EndSession.on_request_end

fiftyone.server.extensions.EndSession.html#on_request_end

Function

Method

PUBLIC

Undocumented
fiftyone.server.events.state.Listener

fiftyone.server.events.state.Listener.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.events.state.Listener.queue

fiftyone.server.events.state.Listener.html#queue

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.events.state.Listener.subscription

fiftyone.server.events.state.Listener.html#subscription

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.events.state._LISTENERS

fiftyone.server.events.state.html#_LISTENERS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.server.events.state._REQUESTS

fiftyone.server.events.state.html#_REQUESTS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.server.events.state._app_count

fiftyone.server.events.state.html#_app_count

Attribute

Variable

PRIVATE

Undocumented
fiftyone.server.events.state._port

fiftyone.server.events.state.html#_port

Attribute

Variable

PRIVATE

Undocumented
fiftyone.server.events.state._state

fiftyone.server.events.state.html#_state

Attribute

Variable

PRIVATE

Undocumented
fiftyone.server.events.state.get_state

fiftyone.server.events.state.html#get_state

Function

Function

PUBLIC

Get the current state description singleton on the server if it exists. Otherwise, initializes and sets the state description with default values.
fiftyone.server.events.state.set_state

fiftyone.server.events.state.html#set_state

Function

Function

PUBLIC

Set the current state.
fiftyone.server.events.state.get_app_count

fiftyone.server.events.state.html#get_app_count

Function

Function

PUBLIC

Undocumented
fiftyone.server.events.state.decrement_app_count

fiftyone.server.events.state.html#decrement_app_count

Function

Function

PUBLIC

Undocumented
fiftyone.server.events.state.increment_app_count

fiftyone.server.events.state.html#increment_app_count

Function

Function

PUBLIC

Undocumented
fiftyone.server.events.state.get_listeners

fiftyone.server.events.state.html#get_listeners

Function

Function

PUBLIC

Undocumented
fiftyone.server.events.state.get_requests

fiftyone.server.events.state.html#get_requests

Function

Function

PUBLIC

Undocumented
fiftyone.server.events.state.get_port

fiftyone.server.events.state.html#get_port

Function

Function

PUBLIC

Undocumented
fiftyone.server.events.state.set_port

fiftyone.server.events.state.html#set_port

Function

Function

PUBLIC

Undocumented
fiftyone.server.events.dispatch.dispatch_event

fiftyone.server.events.dispatch.html#dispatch_event

Function

Function

PUBLIC

Dispatch an event to all listeners registered for the server process
fiftyone.server.events.initialize.InitializedListener

fiftyone.server.events.initialize.InitializedListener.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.events.initialize.InitializedListener.is_app

fiftyone.server.events.initialize.InitializedListener.html#is_app

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.events.initialize.InitializedListener.request_listeners

fiftyone.server.events.initialize.InitializedListener.html#request_listeners

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.events.initialize.InitializedListener.state

fiftyone.server.events.initialize.InitializedListener.html#state

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.events.initialize.initialize_listener

fiftyone.server.events.initialize.html#initialize_listener

Function

Function

PUBLIC

Initialize a state listener.
fiftyone.server.events.initialize.initialize_listener_sync

fiftyone.server.events.initialize.html#initialize_listener_sync

Function

Function

PUBLIC

Synchronously initializer a listener
fiftyone.server.events.initialize.handle_app_initializer

fiftyone.server.events.initialize.html#handle_app_initializer

Function

Function

PUBLIC

Handle an App initialization request
fiftyone.server.events.initialize.handle_dataset_change

fiftyone.server.events.initialize.html#handle_dataset_change

Function

Function

PUBLIC

Handle a dataset change request.
fiftyone.server.events.initialize.handle_group_slice

fiftyone.server.events.initialize.html#handle_group_slice

Function

Function

PUBLIC

Handle a group slice.
fiftyone.server.events.initialize.handle_group_id

fiftyone.server.events.initialize.html#handle_group_id

Function

Function

PUBLIC

Handle a group id.
fiftyone.server.events.initialize.handle_sample_id

fiftyone.server.events.initialize.html#handle_sample_id

Function

Function

PUBLIC

Handle a sample id.
fiftyone.server.events.initialize.handle_saved_view

fiftyone.server.events.initialize.html#handle_saved_view

Function

Function

PUBLIC

Handle a saved view slug.
fiftyone.server.events.initialize.handle_workspace

fiftyone.server.events.initialize.html#handle_workspace

Function

Function

PUBLIC

Handle a workspace slug request.
fiftyone.server.events.listener.add_event_listener

fiftyone.server.events.listener.html#add_event_listener

Function

Function

PUBLIC

Add an event listener to the server
fiftyone.server.events.listener._disconnect

fiftyone.server.events.listener.html#_disconnect

Function

Function

PRIVATE

Undocumented
fiftyone.server.events.polling._polling_listener

fiftyone.server.events.polling.html#_polling_listener

Attribute

Variable

PRIVATE

Undocumented
fiftyone.server.events.polling.dispatch_polling_event_listener

fiftyone.server.events.polling.html#dispatch_polling_event_listener

Function

Function

PUBLIC

Polling event listener interface
fiftyone.server.color.fop

fiftyone.server.color.html#fop

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.color.ValueColor

fiftyone.server.color.ValueColor.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.ValueColor.color

fiftyone.server.color.ValueColor.html#color

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ValueColor.value

fiftyone.server.color.ValueColor.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.MaskColor

fiftyone.server.color.MaskColor.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.MaskColor.color

fiftyone.server.color.MaskColor.html#color

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.MaskColor.intTarget

fiftyone.server.color.MaskColor.html#intTarget

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.CustomizeColor

fiftyone.server.color.CustomizeColor.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.CustomizeColor.path

fiftyone.server.color.CustomizeColor.html#path

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.CustomizeColor.valueColors

fiftyone.server.color.CustomizeColor.html#valueColors

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.CustomizeColor.colorByAttribute

fiftyone.server.color.CustomizeColor.html#colorByAttribute

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.CustomizeColor.fieldColor

fiftyone.server.color.CustomizeColor.html#fieldColor

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.CustomizeColor.maskTargetsColors

fiftyone.server.color.CustomizeColor.html#maskTargetsColors

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.LabelTagColor

fiftyone.server.color.LabelTagColor.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.LabelTagColor.fieldColor

fiftyone.server.color.LabelTagColor.html#fieldColor

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.LabelTagColor.valueColors

fiftyone.server.color.LabelTagColor.html#valueColors

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorscaleList

fiftyone.server.color.ColorscaleList.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.ColorscaleList.color

fiftyone.server.color.ColorscaleList.html#color

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorscaleList.value

fiftyone.server.color.ColorscaleList.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.Colorscale

fiftyone.server.color.Colorscale.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.Colorscale.path

fiftyone.server.color.Colorscale.html#path

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.Colorscale.name

fiftyone.server.color.Colorscale.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.Colorscale.list

fiftyone.server.color.Colorscale.html#list

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.Colorscale.rgb

fiftyone.server.color.Colorscale.html#rgb

Function

Method

PUBLIC

Undocumented
fiftyone.server.color.DefaultColorscale

fiftyone.server.color.DefaultColorscale.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.DefaultColorscale.name

fiftyone.server.color.DefaultColorscale.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.DefaultColorscale.list

fiftyone.server.color.DefaultColorscale.html#list

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.DefaultColorscale.rgb

fiftyone.server.color.DefaultColorscale.html#rgb

Function

Method

PUBLIC

Undocumented
fiftyone.server.color.ColorBy

fiftyone.server.color.ColorBy.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.ColorBy.field

fiftyone.server.color.ColorBy.html#field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorBy.instance

fiftyone.server.color.ColorBy.html#instance

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorBy.value

fiftyone.server.color.ColorBy.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorScheme

fiftyone.server.color.ColorScheme.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.ColorScheme.id

fiftyone.server.color.ColorScheme.html#id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorScheme.color_pool

fiftyone.server.color.ColorScheme.html#color_pool

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorScheme.color_by

fiftyone.server.color.ColorScheme.html#color_by

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorScheme.fields

fiftyone.server.color.ColorScheme.html#fields

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorScheme.label_tags

fiftyone.server.color.ColorScheme.html#label_tags

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorScheme.multicolor_keypoints

fiftyone.server.color.ColorScheme.html#multicolor_keypoints

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorScheme.opacity

fiftyone.server.color.ColorScheme.html#opacity

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorScheme.show_skeletons

fiftyone.server.color.ColorScheme.html#show_skeletons

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorScheme.default_mask_targets_colors

fiftyone.server.color.ColorScheme.html#default_mask_targets_colors

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorScheme.colorscales

fiftyone.server.color.ColorScheme.html#colorscales

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorScheme.default_colorscale

fiftyone.server.color.ColorScheme.html#default_colorscale

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ValueColorInput

fiftyone.server.color.ValueColorInput.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.ValueColorInput.color

fiftyone.server.color.ValueColorInput.html#color

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ValueColorInput.value

fiftyone.server.color.ValueColorInput.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.MaskColorInput

fiftyone.server.color.MaskColorInput.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.MaskColorInput.color

fiftyone.server.color.MaskColorInput.html#color

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.MaskColorInput.intTarget

fiftyone.server.color.MaskColorInput.html#intTarget

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorscaleListInput

fiftyone.server.color.ColorscaleListInput.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.ColorscaleListInput.color

fiftyone.server.color.ColorscaleListInput.html#color

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorscaleListInput.value

fiftyone.server.color.ColorscaleListInput.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorscaleInput

fiftyone.server.color.ColorscaleInput.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.ColorscaleInput.path

fiftyone.server.color.ColorscaleInput.html#path

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorscaleInput.name

fiftyone.server.color.ColorscaleInput.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorscaleInput.list

fiftyone.server.color.ColorscaleInput.html#list

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.DefaultColorscaleInput

fiftyone.server.color.DefaultColorscaleInput.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.DefaultColorscaleInput.name

fiftyone.server.color.DefaultColorscaleInput.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.DefaultColorscaleInput.list

fiftyone.server.color.DefaultColorscaleInput.html#list

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.CustomizeColorInput

fiftyone.server.color.CustomizeColorInput.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.CustomizeColorInput.path

fiftyone.server.color.CustomizeColorInput.html#path

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.CustomizeColorInput.valueColors

fiftyone.server.color.CustomizeColorInput.html#valueColors

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.CustomizeColorInput.colorByAttribute

fiftyone.server.color.CustomizeColorInput.html#colorByAttribute

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.CustomizeColorInput.fieldColor

fiftyone.server.color.CustomizeColorInput.html#fieldColor

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.CustomizeColorInput.maskTargetsColors

fiftyone.server.color.CustomizeColorInput.html#maskTargetsColors

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.LabelTagColorInput

fiftyone.server.color.LabelTagColorInput.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.LabelTagColorInput.fieldColor

fiftyone.server.color.LabelTagColorInput.html#fieldColor

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.LabelTagColorInput.valueColors

fiftyone.server.color.LabelTagColorInput.html#valueColors

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorSchemeInput

fiftyone.server.color.ColorSchemeInput.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.ColorSchemeInput.color_pool

fiftyone.server.color.ColorSchemeInput.html#color_pool

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorSchemeInput.id

fiftyone.server.color.ColorSchemeInput.html#id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorSchemeInput.color_by

fiftyone.server.color.ColorSchemeInput.html#color_by

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorSchemeInput.fields

fiftyone.server.color.ColorSchemeInput.html#fields

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorSchemeInput.label_tags

fiftyone.server.color.ColorSchemeInput.html#label_tags

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorSchemeInput.multicolor_keypoints

fiftyone.server.color.ColorSchemeInput.html#multicolor_keypoints

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorSchemeInput.opacity

fiftyone.server.color.ColorSchemeInput.html#opacity

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorSchemeInput.show_skeletons

fiftyone.server.color.ColorSchemeInput.html#show_skeletons

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorSchemeInput.default_mask_targets_colors

fiftyone.server.color.ColorSchemeInput.html#default_mask_targets_colors

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorSchemeInput.colorscales

fiftyone.server.color.ColorSchemeInput.html#colorscales

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.ColorSchemeInput.default_colorscale

fiftyone.server.color.ColorSchemeInput.html#default_colorscale

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.color.SetColorScheme

fiftyone.server.color.SetColorScheme.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.color.SetColorScheme.set_color_scheme

fiftyone.server.color.SetColorScheme.html#set_color_scheme

Function

Method

PUBLIC

Undocumented
fiftyone.server.color.SetColorScheme.set_dataset_color_scheme

fiftyone.server.color.SetColorScheme.html#set_dataset_color_scheme

Function

Method

PUBLIC

Undocumented
fiftyone.server.color._to_odm_color_scheme

fiftyone.server.color.html#_to_odm_color_scheme

Function

Function

PRIVATE

Undocumented
fiftyone.server.indexes._FRAMES_SLICE

fiftyone.server.indexes.html#_FRAMES_SLICE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.server.indexes._WILDCARD_PROJECTION

fiftyone.server.indexes.html#_WILDCARD_PROJECTION

Attribute

Constant

PRIVATE

Undocumented
fiftyone.server.indexes.IndexType

fiftyone.server.indexes.IndexType.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.indexes.IndexType.asc

fiftyone.server.indexes.IndexType.html#asc

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.indexes.IndexType.desc

fiftyone.server.indexes.IndexType.html#desc

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.indexes.IndexFields

fiftyone.server.indexes.IndexFields.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.indexes.IndexFields.field

fiftyone.server.indexes.IndexFields.html#field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.indexes.IndexFields.type

fiftyone.server.indexes.IndexFields.html#type

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.indexes.WildcardProjection

fiftyone.server.indexes.WildcardProjection.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.indexes.WildcardProjection.fields

fiftyone.server.indexes.WildcardProjection.html#fields

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.indexes.WildcardProjection.inclusion

fiftyone.server.indexes.WildcardProjection.html#inclusion

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.indexes.Index

fiftyone.server.indexes.Index.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.indexes.Index.name

fiftyone.server.indexes.Index.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.indexes.Index.key

fiftyone.server.indexes.Index.html#key

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.indexes.Index.unique

fiftyone.server.indexes.Index.html#unique

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.indexes.Index.wildcard_projection

fiftyone.server.indexes.Index.html#wildcard_projection

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.indexes.from_dict

fiftyone.server.indexes.html#from_dict

Function

Function

PUBLIC

Undocumented
fiftyone.server.indexes._from_dict

fiftyone.server.indexes.html#_from_dict

Function

Function

PRIVATE

Undocumented
fiftyone.server.indexes._index_key_from_dict

fiftyone.server.indexes.html#_index_key_from_dict

Function

Function

PRIVATE

Undocumented
fiftyone.server.lightning._TWENTY_FOUR

fiftyone.server.lightning.html#_TWENTY_FOUR

Attribute

Constant

PRIVATE

Undocumented
fiftyone.server.lightning.LightningPathInput

fiftyone.server.lightning.LightningPathInput.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.lightning.LightningPathInput.path

fiftyone.server.lightning.LightningPathInput.html#path

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.LightningPathInput.exclude

fiftyone.server.lightning.LightningPathInput.html#exclude

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.LightningPathInput.search

fiftyone.server.lightning.LightningPathInput.html#search

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.LightningPathInput.filters

fiftyone.server.lightning.LightningPathInput.html#filters

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.LightningInput

fiftyone.server.lightning.LightningInput.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.lightning.LightningInput.dataset

fiftyone.server.lightning.LightningInput.html#dataset

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.LightningInput.paths

fiftyone.server.lightning.LightningInput.html#paths

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.LightningInput.slice

fiftyone.server.lightning.LightningInput.html#slice

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.LightningResult

fiftyone.server.lightning.LightningResult.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.lightning.LightningResult.path

fiftyone.server.lightning.LightningResult.html#path

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.BooleanLightningResult

fiftyone.server.lightning.BooleanLightningResult.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.lightning.BooleanLightningResult.false

fiftyone.server.lightning.BooleanLightningResult.html#false

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.BooleanLightningResult.none

fiftyone.server.lightning.BooleanLightningResult.html#none

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.BooleanLightningResult.true

fiftyone.server.lightning.BooleanLightningResult.html#true

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.DateLightningResult

fiftyone.server.lightning.DateLightningResult.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.lightning.DateLightningResult.max

fiftyone.server.lightning.DateLightningResult.html#max

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.DateLightningResult.min

fiftyone.server.lightning.DateLightningResult.html#min

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.DateLightningResult.none

fiftyone.server.lightning.DateLightningResult.html#none

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.DateTimeLightningResult

fiftyone.server.lightning.DateTimeLightningResult.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.lightning.DateTimeLightningResult.max

fiftyone.server.lightning.DateTimeLightningResult.html#max

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.DateTimeLightningResult.min

fiftyone.server.lightning.DateTimeLightningResult.html#min

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.DateTimeLightningResult.none

fiftyone.server.lightning.DateTimeLightningResult.html#none

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.FloatLightningResult

fiftyone.server.lightning.FloatLightningResult.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.lightning.FloatLightningResult.inf

fiftyone.server.lightning.FloatLightningResult.html#inf

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.FloatLightningResult.max

fiftyone.server.lightning.FloatLightningResult.html#max

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.FloatLightningResult.min

fiftyone.server.lightning.FloatLightningResult.html#min

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.FloatLightningResult.nan

fiftyone.server.lightning.FloatLightningResult.html#nan

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.FloatLightningResult.ninf

fiftyone.server.lightning.FloatLightningResult.html#ninf

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.FloatLightningResult.none

fiftyone.server.lightning.FloatLightningResult.html#none

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.IntLightningResult

fiftyone.server.lightning.IntLightningResult.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.lightning.IntLightningResult.max

fiftyone.server.lightning.IntLightningResult.html#max

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.IntLightningResult.min

fiftyone.server.lightning.IntLightningResult.html#min

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.IntLightningResult.none

fiftyone.server.lightning.IntLightningResult.html#none

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.ObjectIdLightningResult

fiftyone.server.lightning.ObjectIdLightningResult.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.lightning.ObjectIdLightningResult.values

fiftyone.server.lightning.ObjectIdLightningResult.html#values

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.StringLightningResult

fiftyone.server.lightning.StringLightningResult.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.lightning.StringLightningResult.values

fiftyone.server.lightning.StringLightningResult.html#values

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.INT_CLS

fiftyone.server.lightning.html#INT_CLS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.server.lightning.LightningResults

fiftyone.server.lightning.html#LightningResults

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.lightning.lightning_resolver

fiftyone.server.lightning.html#lightning_resolver

Function

Function

PUBLIC

Undocumented
fiftyone.server.lightning.DistinctQuery

fiftyone.server.lightning.DistinctQuery.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.lightning.DistinctQuery.path

fiftyone.server.lightning.DistinctQuery.html#path

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.DistinctQuery.first

fiftyone.server.lightning.DistinctQuery.html#first

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.DistinctQuery.has_list

fiftyone.server.lightning.DistinctQuery.html#has_list

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.DistinctQuery.is_object_id_field

fiftyone.server.lightning.DistinctQuery.html#is_object_id_field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.DistinctQuery.exclude

fiftyone.server.lightning.DistinctQuery.html#exclude

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.DistinctQuery.search

fiftyone.server.lightning.DistinctQuery.html#search

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning.DistinctQuery.filters

fiftyone.server.lightning.DistinctQuery.html#filters

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.lightning._resolve_lightning_path_queries

fiftyone.server.lightning.html#_resolve_lightning_path_queries

Function

Function

PRIVATE

Undocumented
fiftyone.server.lightning._do_async_pooled_queries

fiftyone.server.lightning.html#_do_async_pooled_queries

Function

Function

PRIVATE

Undocumented
fiftyone.server.lightning._do_async_query

fiftyone.server.lightning.html#_do_async_query

Function

Function

PRIVATE

Undocumented
fiftyone.server.lightning._do_distinct_query

fiftyone.server.lightning.html#_do_distinct_query

Function

Function

PRIVATE

Undocumented
fiftyone.server.lightning._do_distinct_pipeline

fiftyone.server.lightning.html#_do_distinct_pipeline

Function

Function

PRIVATE

Undocumented
fiftyone.server.lightning._first

fiftyone.server.lightning.html#_first

Function

Function

PRIVATE

Undocumented
fiftyone.server.lightning._handle_nonfinites

fiftyone.server.lightning.html#_handle_nonfinites

Function

Function

PRIVATE

Undocumented
fiftyone.server.lightning._has_list

fiftyone.server.lightning.html#_has_list

Function

Function

PRIVATE

Undocumented
fiftyone.server.lightning._match

fiftyone.server.lightning.html#_match

Function

Function

PRIVATE

Undocumented
fiftyone.server.lightning._match_arrays

fiftyone.server.lightning.html#_match_arrays

Function

Function

PRIVATE

Undocumented
fiftyone.server.lightning._parse_result

fiftyone.server.lightning.html#_parse_result

Function

Function

PRIVATE

Undocumented
fiftyone.server.lightning._unwind

fiftyone.server.lightning.html#_unwind

Function

Function

PRIVATE

Undocumented
fiftyone.utils.utils3d.o3d

fiftyone.utils.utils3d.html#o3d

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.utils3d.logger

fiftyone.utils.utils3d.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.utils3d.DEFAULT_SHADING_GRADIENT_MAP

fiftyone.utils.utils3d.html#DEFAULT_SHADING_GRADIENT_MAP

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.utils3d._EDGES

fiftyone.utils.utils3d.html#_EDGES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.utils3d._FACES

fiftyone.utils.utils3d.html#_FACES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.utils3d._UNIT_BOX

fiftyone.utils.utils3d.html#_UNIT_BOX

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.utils3d._NUM_KEYPOINTS

fiftyone.utils.utils3d.html#_NUM_KEYPOINTS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.utils3d._FRONT_FACE_ID

fiftyone.utils.utils3d.html#_FRONT_FACE_ID

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.utils3d._TOP_FACE_ID

fiftyone.utils.utils3d.html#_TOP_FACE_ID

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.utils3d._PLANE_THICKNESS_EPSILON

fiftyone.utils.utils3d.html#_PLANE_THICKNESS_EPSILON

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.utils3d._POINT_IN_FRONT_OF_PLANE

fiftyone.utils.utils3d.html#_POINT_IN_FRONT_OF_PLANE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.utils3d._POINT_ON_PLANE

fiftyone.utils.utils3d.html#_POINT_ON_PLANE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.utils3d._POINT_BEHIND_PLANE

fiftyone.utils.utils3d.html#_POINT_BEHIND_PLANE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.utils3d.compute_cuboid_iou

fiftyone.utils.utils3d.html#compute_cuboid_iou

Function

Function

PUBLIC

Computes the IoU between the given ground truth and predicted cuboids.
fiftyone.utils.utils3d._Box

fiftyone.utils.utils3d._Box.html

Class

Class

PRIVATE

No class docstring; 0/6 instance variable, 2/5 methods documented
fiftyone.utils.utils3d._Box.__init__

fiftyone.utils.utils3d._Box.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.utils3d._Box.rotation

fiftyone.utils.utils3d._Box.html#rotation

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.utils3d._Box.translation

fiftyone.utils.utils3d._Box.html#translation

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.utils3d._Box.scale

fiftyone.utils.utils3d._Box.html#scale

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.utils3d._Box.volume

fiftyone.utils.utils3d._Box.html#volume

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.utils3d._Box.transformation

fiftyone.utils.utils3d._Box.html#transformation

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.utils3d._Box.vertices

fiftyone.utils.utils3d._Box.html#vertices

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.utils3d._Box._inside

fiftyone.utils.utils3d._Box.html#_inside

Function

Method

PRIVATE

Undocumented
fiftyone.utils.utils3d._Box._apply_transformation

fiftyone.utils.utils3d._Box.html#_apply_transformation

Function

Method

PRIVATE

Undocumented
fiftyone.utils.utils3d._Box._scaled_axis_aligned_vertices

fiftyone.utils.utils3d._Box.html#_scaled_axis_aligned_vertices

Function

Method

PRIVATE

Returns axis-aligned vertices for a box of the given scale.
fiftyone.utils.utils3d._Box._get_ground_plane

fiftyone.utils.utils3d._Box.html#_get_ground_plane

Function

Method

PRIVATE

Gets the ground plane under the box.
fiftyone.utils.utils3d._inside

fiftyone.utils.utils3d.html#_inside

Function

Function

PRIVATE

Checks whether a given point is on a 2D plane.
fiftyone.utils.utils3d._classify_point_to_plane

fiftyone.utils.utils3d.html#_classify_point_to_plane

Function

Function

PRIVATE

Classify position of a point w.r.t the given plane.
fiftyone.utils.utils3d._clip_poly

fiftyone.utils.utils3d.html#_clip_poly

Function

Function

PRIVATE

Clips the polygon with the plane using the Sutherland-Hodgman algorithm.
fiftyone.utils.utils3d._intersect_box_poly

fiftyone.utils.utils3d.html#_intersect_box_poly

Function

Function

PRIVATE

Clips the polygon against the faces of the axis-aligned box.
fiftyone.utils.utils3d._intersect

fiftyone.utils.utils3d.html#_intersect

Function

Function

PRIVATE

Computes the intersection of a line with an axis-aligned plane.
fiftyone.utils.utils3d._compute_intersection_points

fiftyone.utils.utils3d.html#_compute_intersection_points

Function

Function

PRIVATE

Computes the intersection of two boxes.
fiftyone.utils.utils3d.OrthographicProjectionMetadata

fiftyone.utils.utils3d.OrthographicProjectionMetadata.html

Class

Class

PUBLIC

Class for storing metadata about orthographic projections.
fiftyone.utils.utils3d.OrthographicProjectionMetadata.filepath

fiftyone.utils.utils3d.OrthographicProjectionMetadata.html#filepath

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.utils.utils3d.OrthographicProjectionMetadata.min_bound

fiftyone.utils.utils3d.OrthographicProjectionMetadata.html#min_bound

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.utils.utils3d.OrthographicProjectionMetadata.max_bound

fiftyone.utils.utils3d.OrthographicProjectionMetadata.html#max_bound

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.utils.utils3d.OrthographicProjectionMetadata.normal

fiftyone.utils.utils3d.OrthographicProjectionMetadata.html#normal

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.utils.utils3d.OrthographicProjectionMetadata._MEDIA_FIELD

fiftyone.utils.utils3d.OrthographicProjectionMetadata.html#_MEDIA_FIELD

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.utils3d.OrthographicProjectionMetadata.width

fiftyone.utils.utils3d.OrthographicProjectionMetadata.html#width

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.utils.utils3d.OrthographicProjectionMetadata.height

fiftyone.utils.utils3d.OrthographicProjectionMetadata.html#height

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.utils.utils3d._get_scene_paths

fiftyone.utils.utils3d.html#_get_scene_paths

Function

Function

PRIVATE

Return Tuple of scene paths to use and whether all are local This function is a no-op here but could be different in a repo fork.
fiftyone.utils.utils3d._get_scene_asset_paths_single

fiftyone.utils.utils3d.html#_get_scene_asset_paths_single

Function

Function

PRIVATE

Undocumented
fiftyone.utils.utils3d.get_scene_asset_paths

fiftyone.utils.utils3d.html#get_scene_asset_paths

Function

Function

PUBLIC

Extracts all asset paths for the specified 3D scenes.
fiftyone.utils.utils3d.compute_orthographic_projection_images

fiftyone.utils.utils3d.html#compute_orthographic_projection_images

Function

Function

PUBLIC

Computes orthographic projection images for the point clouds in the given collection.
fiftyone.utils.utils3d.compute_orthographic_projection_image

fiftyone.utils.utils3d.html#compute_orthographic_projection_image

Function

Function

PUBLIC

Generates an orthographic projection image for the given PCD file onto the specified plane (default xy plane).
fiftyone.utils.utils3d._get_pcd_filepath_from_scene

fiftyone.utils.utils3d.html#_get_pcd_filepath_from_scene

Function

Function

PRIVATE

Undocumented
fiftyone.utils.utils3d._parse_point_cloud

fiftyone.utils.utils3d.html#_parse_point_cloud

Function

Function

PRIVATE

Undocumented
fiftyone.utils.utils3d._get_3d_slice

fiftyone.utils.utils3d.html#_get_3d_slice

Function

Function

PRIVATE

Undocumented
fiftyone.utils.utils3d._clamp_to_discrete

fiftyone.utils.utils3d.html#_clamp_to_discrete

Function

Function

PRIVATE

Discretize by mapping each continuous value in arr to the closest value in discrete.
fiftyone.utils.utils3d._parse_size

fiftyone.utils.utils3d.html#_parse_size

Function

Function

PRIVATE

Undocumented
fiftyone.utils.utils3d._contains_none

fiftyone.utils.utils3d.html#_contains_none

Function

Function

PRIVATE

Undocumented
fiftyone.utils.utils3d._fill_none

fiftyone.utils.utils3d.html#_fill_none

Function

Function

PRIVATE

Undocumented
fiftyone.utils.utils3d.pcd_to_3d

fiftyone.utils.utils3d.html#pcd_to_3d

Function

Function

PUBLIC

Converts the point cloud samples in the given dataset to 3D samples.
fiftyone.utils.utils3d._pcd_slices_to_3d_slices

fiftyone.utils.utils3d.html#_pcd_slices_to_3d_slices

Function

Function

PRIVATE

Undocumented
fiftyone.utils.utils3d._pcd_to_3d

fiftyone.utils.utils3d.html#_pcd_to_3d

Function

Function

PRIVATE

Undocumented
fiftyone.utils.utils3d._make_scene

fiftyone.utils.utils3d.html#_make_scene

Function

Function

PRIVATE

Undocumented
fiftyone.utils.rerun.RrdFile

fiftyone.utils.rerun.RrdFile.html

Class

Class

PUBLIC

Class for storing a rerun data (rrd) file and its associated metadata.
fiftyone.utils.rerun.RrdFile.filepath

fiftyone.utils.rerun.RrdFile.html#filepath

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.utils.rerun.RrdFile.version

fiftyone.utils.rerun.RrdFile.html#version

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.utils.rerun.RrdFile._MEDIA_FIELD

fiftyone.utils.rerun.RrdFile.html#_MEDIA_FIELD

Attribute

Constant

PRIVATE

Undocumented
fiftyone.server.metadata.logger

fiftyone.server.metadata.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.metadata._ADDITIONAL_MEDIA_FIELDS

fiftyone.server.metadata.html#_ADDITIONAL_MEDIA_FIELDS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.server.metadata._FFPROBE_BINARY_PATH

fiftyone.server.metadata.html#_FFPROBE_BINARY_PATH

Attribute

Constant

PRIVATE

Undocumented
fiftyone.server.metadata.MediaType

fiftyone.server.metadata.MediaType.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.metadata.MediaType.image

fiftyone.server.metadata.MediaType.html#image

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.metadata.MediaType.group

fiftyone.server.metadata.MediaType.html#group

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.metadata.MediaType.point_cloud

fiftyone.server.metadata.MediaType.html#point_cloud

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.metadata.MediaType.three_d

fiftyone.server.metadata.MediaType.html#three_d

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.metadata.MediaType.video

fiftyone.server.metadata.MediaType.html#video

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.metadata.get_metadata

fiftyone.server.metadata.html#get_metadata

Function

Function

PUBLIC

Gets the metadata for the given local media file.
fiftyone.server.metadata.read_metadata

fiftyone.server.metadata.html#read_metadata

Function

Function

PUBLIC

Calculates the metadata for the given local media path.
fiftyone.server.metadata.Reader

fiftyone.server.metadata.Reader.html

Class

Class

PUBLIC

Asynchronous file-like reader.
fiftyone.server.metadata.Reader.__init__

fiftyone.server.metadata.Reader.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.server.metadata.Reader._data

fiftyone.server.metadata.Reader.html#_data

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.server.metadata.Reader._content

fiftyone.server.metadata.Reader.html#_content

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.server.metadata.Reader.read

fiftyone.server.metadata.Reader.html#read

Function

Method

PUBLIC

Undocumented
fiftyone.server.metadata.Reader.seek

fiftyone.server.metadata.Reader.html#seek

Function

Method

PUBLIC

Undocumented
fiftyone.server.metadata.get_stream_info

fiftyone.server.metadata.html#get_stream_info

Function

Function

PUBLIC

Returns a eta.core.video.VideoStreamInfo instance for the provided video path.
fiftyone.server.metadata.get_image_dimensions

fiftyone.server.metadata.html#get_image_dimensions

Function

Function

PUBLIC

Gets the dimensions of an image from its file-like asynchronous byte stream.
fiftyone.server.metadata.MetadataException

fiftyone.server.metadata.MetadataException.html

Class

Exception

PUBLIC

Exception raised when metadata for a media file cannot be computed.
fiftyone.server.metadata.FFmpegNotFoundException

fiftyone.server.metadata.FFmpegNotFoundException.html

Class

Exception

PUBLIC

Exception raised when FFmpeg or FFprobe cannot be found.
fiftyone.server.metadata._create_media_urls

fiftyone.server.metadata.html#_create_media_urls

Function

Function

PRIVATE

Undocumented
fiftyone.server.metadata._get_additional_media_fields

fiftyone.server.metadata.html#_get_additional_media_fields

Function

Function

PRIVATE

Undocumented
fiftyone.server.paginator.C

fiftyone.server.paginator.html#C

Attribute

Type Variable

PUBLIC

Undocumented
fiftyone.server.paginator.PageInfo

fiftyone.server.paginator.PageInfo.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.paginator.PageInfo.has_next_page

fiftyone.server.paginator.PageInfo.html#has_next_page

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.paginator.PageInfo.has_previous_page

fiftyone.server.paginator.PageInfo.html#has_previous_page

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.paginator.PageInfo.start_cursor

fiftyone.server.paginator.PageInfo.html#start_cursor

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.paginator.PageInfo.end_cursor

fiftyone.server.paginator.PageInfo.html#end_cursor

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.paginator.Edge

fiftyone.server.paginator.Edge.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.paginator.Edge.cursor

fiftyone.server.paginator.Edge.html#cursor

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.paginator.Edge.node

fiftyone.server.paginator.Edge.html#node

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.paginator.Connection

fiftyone.server.paginator.Connection.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.paginator.Connection.page_info

fiftyone.server.paginator.Connection.html#page_info

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.paginator.Connection.edges

fiftyone.server.paginator.Connection.html#edges

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.paginator.Connection.total

fiftyone.server.paginator.Connection.html#total

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.paginator.get_items

fiftyone.server.paginator.html#get_items

Function

Function

PUBLIC

Undocumented
fiftyone.server.paginator.get_paginator_resolver

fiftyone.server.paginator.html#get_paginator_resolver

Function

Function

PUBLIC

Undocumented
fiftyone.server.samples.MediaURL

fiftyone.server.samples.MediaURL.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.samples.MediaURL.field

fiftyone.server.samples.MediaURL.html#field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.samples.MediaURL.url

fiftyone.server.samples.MediaURL.html#url

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.samples.Sample

fiftyone.server.samples.Sample.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.samples.Sample.id

fiftyone.server.samples.Sample.html#id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.samples.Sample.sample

fiftyone.server.samples.Sample.html#sample

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.samples.Sample.urls

fiftyone.server.samples.Sample.html#urls

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.samples.Sample.aspect_ratio

fiftyone.server.samples.Sample.html#aspect_ratio

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.samples.ImageSample

fiftyone.server.samples.ImageSample.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.samples.PointCloudSample

fiftyone.server.samples.PointCloudSample.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.samples.ThreeDSample

fiftyone.server.samples.ThreeDSample.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.samples.VideoSample

fiftyone.server.samples.VideoSample.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.samples.VideoSample.frame_number

fiftyone.server.samples.VideoSample.html#frame_number

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.samples.VideoSample.frame_rate

fiftyone.server.samples.VideoSample.html#frame_rate

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.samples.SampleItem

fiftyone.server.samples.html#SampleItem

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.samples.MEDIA_TYPES

fiftyone.server.samples.html#MEDIA_TYPES

Attribute

Constant

PUBLIC

Undocumented
fiftyone.server.samples.paginate_samples

fiftyone.server.samples.html#paginate_samples

Function

Function

PUBLIC

Undocumented
fiftyone.server.samples._create_sample_item

fiftyone.server.samples.html#_create_sample_item

Function

Function

PRIVATE

Undocumented
fiftyone.server.stage_definitions.StageParameter

fiftyone.server.stage_definitions.StageParameter.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.stage_definitions.StageParameter.name

fiftyone.server.stage_definitions.StageParameter.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.stage_definitions.StageParameter.type

fiftyone.server.stage_definitions.StageParameter.html#type

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.stage_definitions.StageParameter.default

fiftyone.server.stage_definitions.StageParameter.html#default

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.stage_definitions.StageParameter.placeholder

fiftyone.server.stage_definitions.StageParameter.html#placeholder

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.stage_definitions.StageDefinition

fiftyone.server.stage_definitions.StageDefinition.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.stage_definitions.StageDefinition.name

fiftyone.server.stage_definitions.StageDefinition.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.stage_definitions.StageDefinition.params

fiftyone.server.stage_definitions.StageDefinition.html#params

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.stage_definitions.stage_definitions

fiftyone.server.stage_definitions.html#stage_definitions

Function

Function

PUBLIC

Undocumented
fiftyone.server.workspace.Workspace

fiftyone.server.workspace.Workspace.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.workspace.Workspace.id

fiftyone.server.workspace.Workspace.html#id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.workspace.Workspace.color

fiftyone.server.workspace.Workspace.html#color

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.workspace.Workspace.child

fiftyone.server.workspace.Workspace.html#child

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.workspace.Workspace.dataset_id

fiftyone.server.workspace.Workspace.html#dataset_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.workspace.Workspace.created_at

fiftyone.server.workspace.Workspace.html#created_at

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.workspace.Workspace.description

fiftyone.server.workspace.Workspace.html#description

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.workspace.Workspace.name

fiftyone.server.workspace.Workspace.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.workspace.Workspace.last_modified_at

fiftyone.server.workspace.Workspace.html#last_modified_at

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.workspace.Workspace.last_loaded_at

fiftyone.server.workspace.Workspace.html#last_loaded_at

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.workspace.Workspace.slug

fiftyone.server.workspace.Workspace.html#slug

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.ID

fiftyone.server.query.html#ID

Attribute

Constant

PUBLIC

Undocumented
fiftyone.server.query.DATASET_FILTER

fiftyone.server.query.html#DATASET_FILTER

Attribute

Constant

PUBLIC

Undocumented
fiftyone.server.query.DATASET_FILTER_STAGE

fiftyone.server.query.html#DATASET_FILTER_STAGE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.server.query.Group

fiftyone.server.query.Group.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.Group.name

fiftyone.server.query.Group.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Group.media_type

fiftyone.server.query.Group.html#media_type

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Target

fiftyone.server.query.Target.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.Target.target

fiftyone.server.query.Target.html#target

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Target.value

fiftyone.server.query.Target.html#value

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.NamedTargets

fiftyone.server.query.NamedTargets.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.NamedTargets.name

fiftyone.server.query.NamedTargets.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.NamedTargets.targets

fiftyone.server.query.NamedTargets.html#targets

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.RunConfig

fiftyone.server.query.RunConfig.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.RunConfig.cls

fiftyone.server.query.RunConfig.html#cls

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Run

fiftyone.server.query.Run.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.Run.key

fiftyone.server.query.Run.html#key

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Run.version

fiftyone.server.query.Run.html#version

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Run.timestamp

fiftyone.server.query.Run.html#timestamp

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Run.config

fiftyone.server.query.Run.html#config

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Run.view_stages

fiftyone.server.query.Run.html#view_stages

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.BrainRunType

fiftyone.server.query.BrainRunType.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.BrainRunType.similarity

fiftyone.server.query.BrainRunType.html#similarity

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.BrainRunType.visualization

fiftyone.server.query.BrainRunType.html#visualization

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.BrainRunConfig

fiftyone.server.query.BrainRunConfig.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.BrainRunConfig.embeddings_field

fiftyone.server.query.BrainRunConfig.html#embeddings_field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.BrainRunConfig.method

fiftyone.server.query.BrainRunConfig.html#method

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.BrainRunConfig.patches_field

fiftyone.server.query.BrainRunConfig.html#patches_field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.BrainRunConfig.supports_prompts

fiftyone.server.query.BrainRunConfig.html#supports_prompts

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.BrainRunConfig.type

fiftyone.server.query.BrainRunConfig.html#type

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.BrainRunConfig.max_k

fiftyone.server.query.BrainRunConfig.html#max_k

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.BrainRunConfig.supports_least_similarity

fiftyone.server.query.BrainRunConfig.html#supports_least_similarity

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.BrainRunConfig._create_config

fiftyone.server.query.BrainRunConfig.html#_create_config

Function

Method

PRIVATE

Undocumented
fiftyone.server.query.BrainRun

fiftyone.server.query.BrainRun.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.BrainRun.config

fiftyone.server.query.BrainRun.html#config

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.EvaluationRunConfig

fiftyone.server.query.EvaluationRunConfig.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.EvaluationRunConfig.gt_field

fiftyone.server.query.EvaluationRunConfig.html#gt_field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.EvaluationRunConfig.pred_field

fiftyone.server.query.EvaluationRunConfig.html#pred_field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.EvaluationRunConfig.method

fiftyone.server.query.EvaluationRunConfig.html#method

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.EvaluationRun

fiftyone.server.query.EvaluationRun.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.EvaluationRun.config

fiftyone.server.query.EvaluationRun.html#config

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.SavedView

fiftyone.server.query.SavedView.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.SavedView.id

fiftyone.server.query.SavedView.html#id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.SavedView.dataset_id

fiftyone.server.query.SavedView.html#dataset_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.SavedView.name

fiftyone.server.query.SavedView.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.SavedView.description

fiftyone.server.query.SavedView.html#description

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.SavedView.color

fiftyone.server.query.SavedView.html#color

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.SavedView.slug

fiftyone.server.query.SavedView.html#slug

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.SavedView.view_stages

fiftyone.server.query.SavedView.html#view_stages

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.SavedView.created_at

fiftyone.server.query.SavedView.html#created_at

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.SavedView.last_modified_at

fiftyone.server.query.SavedView.html#last_modified_at

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.SavedView.last_loaded_at

fiftyone.server.query.SavedView.html#last_loaded_at

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.SavedView.view_name

fiftyone.server.query.SavedView.html#view_name

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.SavedView.stage_dicts

fiftyone.server.query.SavedView.html#stage_dicts

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.SavedView.from_doc

fiftyone.server.query.SavedView.html#from_doc

Function

Class Method

PUBLIC

Undocumented
fiftyone.server.query.SidebarGroup

fiftyone.server.query.SidebarGroup.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.SidebarGroup.name

fiftyone.server.query.SidebarGroup.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.SidebarGroup.paths

fiftyone.server.query.SidebarGroup.html#paths

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.SidebarGroup.expanded

fiftyone.server.query.SidebarGroup.html#expanded

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.KeypointSkeleton

fiftyone.server.query.KeypointSkeleton.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.KeypointSkeleton.labels

fiftyone.server.query.KeypointSkeleton.html#labels

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.KeypointSkeleton.edges

fiftyone.server.query.KeypointSkeleton.html#edges

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.NamedKeypointSkeleton

fiftyone.server.query.NamedKeypointSkeleton.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.NamedKeypointSkeleton.name

fiftyone.server.query.NamedKeypointSkeleton.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.DatasetAppConfig

fiftyone.server.query.DatasetAppConfig.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.DatasetAppConfig.color_scheme

fiftyone.server.query.DatasetAppConfig.html#color_scheme

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.DatasetAppConfig.disable_frame_filtering

fiftyone.server.query.DatasetAppConfig.html#disable_frame_filtering

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.DatasetAppConfig.dynamic_groups_target_frame_rate

fiftyone.server.query.DatasetAppConfig.html#dynamic_groups_target_frame_rate

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.DatasetAppConfig.grid_media_field

fiftyone.server.query.DatasetAppConfig.html#grid_media_field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.DatasetAppConfig.media_fields

fiftyone.server.query.DatasetAppConfig.html#media_fields

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.DatasetAppConfig.modal_media_field

fiftyone.server.query.DatasetAppConfig.html#modal_media_field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.DatasetAppConfig.media_fallback

fiftyone.server.query.DatasetAppConfig.html#media_fallback

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.DatasetAppConfig.plugins

fiftyone.server.query.DatasetAppConfig.html#plugins

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.DatasetAppConfig.sidebar_groups

fiftyone.server.query.DatasetAppConfig.html#sidebar_groups

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.DatasetAppConfig.spaces

fiftyone.server.query.DatasetAppConfig.html#spaces

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset

fiftyone.server.query.Dataset.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.Dataset.id

fiftyone.server.query.Dataset.html#id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.dataset_id

fiftyone.server.query.Dataset.html#dataset_id

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.name

fiftyone.server.query.Dataset.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.created_at

fiftyone.server.query.Dataset.html#created_at

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.last_loaded_at

fiftyone.server.query.Dataset.html#last_loaded_at

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.persistent

fiftyone.server.query.Dataset.html#persistent

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.group_media_types

fiftyone.server.query.Dataset.html#group_media_types

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.group_field

fiftyone.server.query.Dataset.html#group_field

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.default_group_slice

fiftyone.server.query.Dataset.html#default_group_slice

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.media_type

fiftyone.server.query.Dataset.html#media_type

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.parent_media_type

fiftyone.server.query.Dataset.html#parent_media_type

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.mask_targets

fiftyone.server.query.Dataset.html#mask_targets

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.default_mask_targets

fiftyone.server.query.Dataset.html#default_mask_targets

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.sample_fields

fiftyone.server.query.Dataset.html#sample_fields

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.frame_fields

fiftyone.server.query.Dataset.html#frame_fields

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.brain_methods

fiftyone.server.query.Dataset.html#brain_methods

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.evaluations

fiftyone.server.query.Dataset.html#evaluations

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.saved_view_slug

fiftyone.server.query.Dataset.html#saved_view_slug

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.saved_views

fiftyone.server.query.Dataset.html#saved_views

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.version

fiftyone.server.query.Dataset.html#version

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.view_cls

fiftyone.server.query.Dataset.html#view_cls

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.view_name

fiftyone.server.query.Dataset.html#view_name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.default_skeleton

fiftyone.server.query.Dataset.html#default_skeleton

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.skeletons

fiftyone.server.query.Dataset.html#skeletons

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.app_config

fiftyone.server.query.Dataset.html#app_config

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.info

fiftyone.server.query.Dataset.html#info

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.frame_indexes

fiftyone.server.query.Dataset.html#frame_indexes

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.sample_indexes

fiftyone.server.query.Dataset.html#sample_indexes

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.frame_collection_name

fiftyone.server.query.Dataset.html#frame_collection_name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.sample_collection_name

fiftyone.server.query.Dataset.html#sample_collection_name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.stages

fiftyone.server.query.Dataset.html#stages

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.Dataset.estimated_sample_count 0

fiftyone.server.query.Dataset.html#estimated_sample_count%200

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.estimated_sample_count

fiftyone.server.query.Dataset.html#estimated_sample_count

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.Dataset.estimated_frame_count 0

fiftyone.server.query.Dataset.html#estimated_frame_count%200

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Dataset.estimated_frame_count

fiftyone.server.query.Dataset.html#estimated_frame_count

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.Dataset.workspace

fiftyone.server.query.Dataset.html#workspace

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.Dataset.modifier

fiftyone.server.query.Dataset.html#modifier

Function

Static Method

PUBLIC

Undocumented
fiftyone.server.query.Dataset.resolver

fiftyone.server.query.Dataset.html#resolver

Function

Class Method

PUBLIC

Undocumented
fiftyone.server.query.dataset_dataloader

fiftyone.server.query.html#dataset_dataloader

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.query.Theme

fiftyone.server.query.Theme.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.Theme.browser

fiftyone.server.query.Theme.html#browser

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Theme.dark

fiftyone.server.query.Theme.html#dark

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Theme.light

fiftyone.server.query.Theme.html#light

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig

fiftyone.server.query.AppConfig.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.color_by

fiftyone.server.query.AppConfig.html#color_by

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.color_pool

fiftyone.server.query.AppConfig.html#color_pool

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.colorscale

fiftyone.server.query.AppConfig.html#colorscale

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.grid_zoom

fiftyone.server.query.AppConfig.html#grid_zoom

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.enable_query_performance

fiftyone.server.query.AppConfig.html#enable_query_performance

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.default_query_performance

fiftyone.server.query.AppConfig.html#default_query_performance

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.loop_videos

fiftyone.server.query.AppConfig.html#loop_videos

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.multicolor_keypoints

fiftyone.server.query.AppConfig.html#multicolor_keypoints

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.notebook_height

fiftyone.server.query.AppConfig.html#notebook_height

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.plugins

fiftyone.server.query.AppConfig.html#plugins

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.show_confidence

fiftyone.server.query.AppConfig.html#show_confidence

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.show_index

fiftyone.server.query.AppConfig.html#show_index

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.show_label

fiftyone.server.query.AppConfig.html#show_label

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.show_skeletons

fiftyone.server.query.AppConfig.html#show_skeletons

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.show_tooltip

fiftyone.server.query.AppConfig.html#show_tooltip

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.theme

fiftyone.server.query.AppConfig.html#theme

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.timezone

fiftyone.server.query.AppConfig.html#timezone

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.use_frame_number

fiftyone.server.query.AppConfig.html#use_frame_number

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.spaces

fiftyone.server.query.AppConfig.html#spaces

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.disable_frame_filtering

fiftyone.server.query.AppConfig.html#disable_frame_filtering

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.AppConfig.media_fallback

fiftyone.server.query.AppConfig.html#media_fallback

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.SchemaResult

fiftyone.server.query.SchemaResult.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.SchemaResult.field_schema

fiftyone.server.query.SchemaResult.html#field_schema

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.SchemaResult.frame_field_schema

fiftyone.server.query.SchemaResult.html#frame_field_schema

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Query

fiftyone.server.query.Query.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.query.Query.aggregations

fiftyone.server.query.Query.html#aggregations

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Query.lightning

fiftyone.server.query.Query.html#lightning

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Query.colorscale

fiftyone.server.query.Query.html#colorscale

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.Query.config

fiftyone.server.query.Query.html#config

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.Query.context

fiftyone.server.query.Query.html#context

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.Query.dev

fiftyone.server.query.Query.html#dev

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.Query.do_not_track

fiftyone.server.query.Query.html#do_not_track

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.Query.estimated_dataset_count

fiftyone.server.query.Query.html#estimated_dataset_count

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.Query.dataset

fiftyone.server.query.Query.html#dataset

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Query.datasets

fiftyone.server.query.Query.html#datasets

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Query.samples

fiftyone.server.query.Query.html#samples

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.Query.sample

fiftyone.server.query.Query.html#sample

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.Query.stage_definitions

fiftyone.server.query.Query.html#stage_definitions

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.query.Query.uid

fiftyone.server.query.Query.html#uid

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.Query.version

fiftyone.server.query.Query.html#version

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.Query.saved_views

fiftyone.server.query.Query.html#saved_views

Function

Method

PUBLIC

Undocumented
fiftyone.server.query.Query.schema_for_view_stages

fiftyone.server.query.Query.html#schema_for_view_stages

Function

Method

PUBLIC

Undocumented
fiftyone.server.query._flatten_fields

fiftyone.server.query.html#_flatten_fields

Function

Function

PRIVATE

Undocumented
fiftyone.server.query._convert_targets

fiftyone.server.query.html#_convert_targets

Function

Function

PRIVATE

Undocumented
fiftyone.server.query.serialize_dataset

fiftyone.server.query.html#serialize_dataset

Function

Function

PUBLIC

Undocumented
fiftyone.server.query._assign_estimated_counts

fiftyone.server.query.html#_assign_estimated_counts

Function

Function

PRIVATE

Undocumented
fiftyone.server.query._assign_lightning_info

fiftyone.server.query.html#_assign_lightning_info

Function

Function

PRIVATE

Undocumented
fiftyone.server.mutation._CONVERSION_STAGES

fiftyone.server.mutation.html#_CONVERSION_STAGES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.server.mutation.SidebarGroupInput

fiftyone.server.mutation.SidebarGroupInput.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.mutation.StateForm

fiftyone.server.mutation.StateForm.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.mutation.StateForm.add_stages

fiftyone.server.mutation.StateForm.html#add_stages

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.mutation.StateForm.filters

fiftyone.server.mutation.StateForm.html#filters

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.mutation.StateForm.sample_ids

fiftyone.server.mutation.StateForm.html#sample_ids

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.mutation.StateForm.labels

fiftyone.server.mutation.StateForm.html#labels

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.mutation.StateForm.extended

fiftyone.server.mutation.StateForm.html#extended

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.mutation.StateForm.slice

fiftyone.server.mutation.StateForm.html#slice

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.mutation.SavedViewInfo

fiftyone.server.mutation.SavedViewInfo.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.mutation.SavedViewInfo.name

fiftyone.server.mutation.SavedViewInfo.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.mutation.SavedViewInfo.description

fiftyone.server.mutation.SavedViewInfo.html#description

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.mutation.SavedViewInfo.color

fiftyone.server.mutation.SavedViewInfo.html#color

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.mutation.Mutation

fiftyone.server.mutation.Mutation.html

Class

Class

PUBLIC

No class docstring; 1/13 method documented
fiftyone.server.mutation.Mutation.set_field_visibility_stage

fiftyone.server.mutation.Mutation.html#set_field_visibility_stage

Function

Method

PUBLIC

Undocumented
fiftyone.server.mutation.Mutation.set_dataset

fiftyone.server.mutation.Mutation.html#set_dataset

Function

Method

PUBLIC

Undocumented
fiftyone.server.mutation.Mutation.set_group_slice

fiftyone.server.mutation.Mutation.html#set_group_slice

Function

Method

PUBLIC

Undocumented
fiftyone.server.mutation.Mutation.set_sample

fiftyone.server.mutation.Mutation.html#set_sample

Function

Method

PUBLIC

Undocumented
fiftyone.server.mutation.Mutation.set_sidebar_groups

fiftyone.server.mutation.Mutation.html#set_sidebar_groups

Function

Method

PUBLIC

Undocumented
fiftyone.server.mutation.Mutation.set_selected

fiftyone.server.mutation.Mutation.html#set_selected

Function

Method

PUBLIC

Undocumented
fiftyone.server.mutation.Mutation.set_selected_labels

fiftyone.server.mutation.Mutation.html#set_selected_labels

Function

Method

PUBLIC

Undocumented
fiftyone.server.mutation.Mutation.set_view

fiftyone.server.mutation.Mutation.html#set_view

Function

Method

PUBLIC

Undocumented
fiftyone.server.mutation.Mutation.create_saved_view

fiftyone.server.mutation.Mutation.html#create_saved_view

Function

Method

PUBLIC

Undocumented
fiftyone.server.mutation.Mutation.delete_saved_view

fiftyone.server.mutation.Mutation.html#delete_saved_view

Function

Method

PUBLIC

Undocumented
fiftyone.server.mutation.Mutation.update_saved_view

fiftyone.server.mutation.Mutation.html#update_saved_view

Function

Method

PUBLIC

Updates the editable fields of a saved view
fiftyone.server.mutation.Mutation.set_spaces

fiftyone.server.mutation.Mutation.html#set_spaces

Function

Method

PUBLIC

Undocumented
fiftyone.server.mutation.Mutation.search_select_fields

fiftyone.server.mutation.Mutation.html#search_select_fields

Function

Method

PUBLIC

Undocumented
fiftyone.server.mutation._build_result_view

fiftyone.server.mutation.html#_build_result_view

Function

Function

PRIVATE

Undocumented
fiftyone.server.routes.aggregate.Aggregate

fiftyone.server.routes.aggregate.Aggregate.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.routes.aggregate.Aggregate.post

fiftyone.server.routes.aggregate.Aggregate.html#post

Function

Method

PUBLIC

Undocumented
fiftyone.server.routes.embeddings.MAX_CATEGORIES

fiftyone.server.routes.embeddings.html#MAX_CATEGORIES

Attribute

Constant

PUBLIC

Undocumented
fiftyone.server.routes.embeddings.COLOR_BY_TYPES

fiftyone.server.routes.embeddings.html#COLOR_BY_TYPES

Attribute

Constant

PUBLIC

Undocumented
fiftyone.server.routes.embeddings.get_sample_filter

fiftyone.server.routes.embeddings.html#get_sample_filter

Function

Function

PUBLIC

Undocumented
fiftyone.server.routes.embeddings.OnPlotLoad

fiftyone.server.routes.embeddings.OnPlotLoad.html

Class

Class

PUBLIC

No class docstring; 1/2 method documented
fiftyone.server.routes.embeddings.OnPlotLoad.post

fiftyone.server.routes.embeddings.OnPlotLoad.html#post

Function

Method

PUBLIC

Loads an embeddings plot based on the current view.
fiftyone.server.routes.embeddings.OnPlotLoad._post_sync

fiftyone.server.routes.embeddings.OnPlotLoad.html#_post_sync

Function

Method

PRIVATE

Undocumented
fiftyone.server.routes.embeddings.EmbeddingsSelection

fiftyone.server.routes.embeddings.EmbeddingsSelection.html

Class

Class

PUBLIC

No class docstring; 1/2 method documented
fiftyone.server.routes.embeddings.EmbeddingsSelection.post

fiftyone.server.routes.embeddings.EmbeddingsSelection.html#post

Function

Method

PUBLIC

Determines which points in the embeddings plot to select based on the current extended view.
fiftyone.server.routes.embeddings.EmbeddingsSelection._post_sync

fiftyone.server.routes.embeddings.EmbeddingsSelection.html#_post_sync

Function

Method

PRIVATE

Undocumented
fiftyone.server.routes.embeddings.EmbeddingsExtendedStage

fiftyone.server.routes.embeddings.EmbeddingsExtendedStage.html

Class

Class

PUBLIC

No class docstring; 1/2 method documented
fiftyone.server.routes.embeddings.EmbeddingsExtendedStage.post

fiftyone.server.routes.embeddings.EmbeddingsExtendedStage.html#post

Function

Method

PUBLIC

Generates an extended stage that encodes the current selection in the embeddings plot.
fiftyone.server.routes.embeddings.EmbeddingsExtendedStage._post_sync

fiftyone.server.routes.embeddings.EmbeddingsExtendedStage.html#_post_sync

Function

Method

PRIVATE

Undocumented
fiftyone.server.routes.embeddings.ColorByChoices

fiftyone.server.routes.embeddings.ColorByChoices.html

Class

Class

PUBLIC

No class docstring; 1/2 method documented
fiftyone.server.routes.embeddings.ColorByChoices.post

fiftyone.server.routes.embeddings.ColorByChoices.html#post

Function

Method

PUBLIC

Generates a list of color-by field choices for an embeddings plot.
fiftyone.server.routes.embeddings.ColorByChoices._post_sync

fiftyone.server.routes.embeddings.ColorByChoices.html#_post_sync

Function

Method

PRIVATE

Undocumented
fiftyone.server.routes.embeddings.EmbeddingsRoutes

fiftyone.server.routes.embeddings.html#EmbeddingsRoutes

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.routes.embeddings._add_to_trace

fiftyone.server.routes.embeddings.html#_add_to_trace

Function

Function

PRIVATE

Undocumented
fiftyone.server.routes.event.Event

fiftyone.server.routes.event.Event.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.routes.event.Event.post

fiftyone.server.routes.event.Event.html#post

Function

Method

PUBLIC

Undocumented
fiftyone.server.routes.events.Events

fiftyone.server.routes.events.Events.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.routes.events.Events.post

fiftyone.server.routes.events.Events.html#post

Function

Method

PUBLIC

Undocumented
fiftyone.server.routes.fiftyone.FiftyOne

fiftyone.server.routes.fiftyone.FiftyOne.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.routes.fiftyone.FiftyOne.get

fiftyone.server.routes.fiftyone.FiftyOne.html#get

Function

Method

PUBLIC

Undocumented
fiftyone.server.routes.frames.Frames

fiftyone.server.routes.frames.Frames.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.routes.frames.Frames.post

fiftyone.server.routes.frames.Frames.html#post

Function

Method

PUBLIC

Undocumented
fiftyone.server.routes.media.ranged

fiftyone.server.routes.media.html#ranged

Function

Function

PUBLIC

Undocumented
fiftyone.server.routes.media.Media

fiftyone.server.routes.media.Media.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.routes.media.Media.get

fiftyone.server.routes.media.Media.html#get

Function

Method

PUBLIC

Undocumented
fiftyone.server.routes.media.Media.ranged_file_response

fiftyone.server.routes.media.Media.html#ranged_file_response

Function

Method

PUBLIC

Undocumented
fiftyone.server.routes.media.Media.head

fiftyone.server.routes.media.Media.html#head

Function

Method

PUBLIC

Undocumented
fiftyone.server.routes.media.Media.options

fiftyone.server.routes.media.Media.html#options

Function

Method

PUBLIC

Undocumented
fiftyone.server.routes.plugins.Plugins

fiftyone.server.routes.plugins.Plugins.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.routes.plugins.Plugins.get

fiftyone.server.routes.plugins.Plugins.html#get

Function

Method

PUBLIC

Undocumented
fiftyone.server.routes.sort.Sort

fiftyone.server.routes.sort.Sort.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.routes.sort.Sort.post

fiftyone.server.routes.sort.Sort.html#post

Function

Method

PUBLIC

Undocumented
fiftyone.server.routes.screenshot.Screenshot

fiftyone.server.routes.screenshot.Screenshot.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.routes.screenshot.Screenshot.get

fiftyone.server.routes.screenshot.Screenshot.html#get

Function

Method

PUBLIC

Undocumented
fiftyone.server.routes.tag.Tag

fiftyone.server.routes.tag.Tag.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.routes.tag.Tag.post

fiftyone.server.routes.tag.Tag.html#post

Function

Method

PUBLIC

Undocumented
fiftyone.server.routes.tagging.Tagging

fiftyone.server.routes.tagging.Tagging.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.routes.tagging.Tagging.post

fiftyone.server.routes.tagging.Tagging.html#post

Function

Method

PUBLIC

Undocumented
fiftyone.server.routes.tagging.build_label_tag_aggregations

fiftyone.server.routes.tagging.html#build_label_tag_aggregations

Function

Function

PUBLIC

Undocumented
fiftyone.server.routes.values.Values

fiftyone.server.routes.values.Values.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.routes.values.Values.post

fiftyone.server.routes.values.Values.html#post

Function

Method

PUBLIC

Undocumented
fiftyone.server.routes.routes

fiftyone.server.routes.html#routes

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.app.Static

fiftyone.server.app.Static.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.app.Static.file_response

fiftyone.server.app.Static.html#file_response

Function

Method

PUBLIC

Undocumented
fiftyone.server.app.Static.get_response

fiftyone.server.app.Static.html#get_response

Function

Method

PUBLIC

Undocumented
fiftyone.server.app.HeadersMiddleware

fiftyone.server.app.HeadersMiddleware.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.app.HeadersMiddleware.dispatch

fiftyone.server.app.HeadersMiddleware.html#dispatch

Function

Method

PUBLIC

Undocumented
fiftyone.server.app.schema

fiftyone.server.app.html#schema

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.app.app

fiftyone.server.app.html#app

Attribute

Variable

PUBLIC

Undocumented
fiftyone.server.interfaces.StageParameter

fiftyone.server.interfaces.StageParameter.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.interfaces.StageParameter._cls

fiftyone.server.interfaces.StageParameter.html#_cls

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.server.interfaces.StageParameter.name

fiftyone.server.interfaces.StageParameter.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.interfaces.StageParameter.kind

fiftyone.server.interfaces.StageParameter.html#kind

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.interfaces.Stage

fiftyone.server.interfaces.Stage.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.interfaces.Stage._cls

fiftyone.server.interfaces.Stage.html#_cls

Attribute

Class Variable

PRIVATE

Undocumented
fiftyone.server.interfaces.Stage.kwargs

fiftyone.server.interfaces.Stage.html#kwargs

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.main.DEBUG_LOGGING

fiftyone.server.main.html#DEBUG_LOGGING

Attribute

Constant

PUBLIC

Undocumented
fiftyone.server.stages.ParameterDefinition

fiftyone.server.stages.ParameterDefinition.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.stages.ParameterDefinition.name

fiftyone.server.stages.ParameterDefinition.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.stages.ParameterDefinition.type

fiftyone.server.stages.ParameterDefinition.html#type

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.stages.ParameterDefinition.default

fiftyone.server.stages.ParameterDefinition.html#default

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.stages.ParameterDefinition.placeholder

fiftyone.server.stages.ParameterDefinition.html#placeholder

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.stages.StageDefinition

fiftyone.server.stages.StageDefinition.html

Class

Class

PUBLIC

Undocumented
fiftyone.server.stages.StageDefinition.name

fiftyone.server.stages.StageDefinition.html#name

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.stages.StageDefinition.params

fiftyone.server.stages.StageDefinition.html#params

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.server.stages.stage_definitions_resolver

fiftyone.server.stages.html#stage_definitions_resolver

Function

Function

PUBLIC

Undocumented
fiftyone.server.tags.get_tag_view

fiftyone.server.tags.html#get_tag_view

Function

Function

PUBLIC

Undocumented
fiftyone.service.ipc.IPCServer

fiftyone.service.ipc.IPCServer.html

Class

Class

PUBLIC

Server that listens for inter-process messages.
fiftyone.service.ipc.IPCServer.timeout

fiftyone.service.ipc.IPCServer.html#timeout

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.service.ipc.IPCServer.__init__

fiftyone.service.ipc.IPCServer.html#__init__

Function

Method

PUBLIC

Constructs (but does not start) a server.
fiftyone.service.ipc.IPCServer.on_message

fiftyone.service.ipc.IPCServer.html#on_message

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.service.ipc.IPCServer.__lock

fiftyone.service.ipc.IPCServer.html#__lock

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.service.ipc.IPCServer.__in_serve_forever

fiftyone.service.ipc.IPCServer.html#__in_serve_forever

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.service.ipc.IPCServer.stop

fiftyone.service.ipc.IPCServer.html#stop

Function

Method

PUBLIC

Stops and shuts down the server.
fiftyone.service.ipc.IPCServer.serve_forever

fiftyone.service.ipc.IPCServer.html#serve_forever

Function

Method

PUBLIC

Handles one request at a time until the server shuts down.
fiftyone.service.ipc.IPCServer.port

fiftyone.service.ipc.IPCServer.html#port

Attribute

Property

PUBLIC

Undocumented
fiftyone.service.ipc.IPCServer.run_in_background

fiftyone.service.ipc.IPCServer.html#run_in_background

Function

Class Method

PUBLIC

Convenience wrapper that creates a new server instance and calls serve_forever in a background thread.
fiftyone.service.ipc.IPCServer.__enter__

fiftyone.service.ipc.IPCServer.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.service.ipc.IPCServer.__exit__

fiftyone.service.ipc.IPCServer.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.service.ipc.IPCRequestHandler

fiftyone.service.ipc.IPCRequestHandler.html

Class

Class

PUBLIC

Undocumented
fiftyone.service.ipc.IPCRequestHandler.handle

fiftyone.service.ipc.IPCRequestHandler.html#handle

Function

Method

PUBLIC

Undocumented
fiftyone.service.ipc.IPCRequestHandler.send_reply

fiftyone.service.ipc.IPCRequestHandler.html#send_reply

Function

Method

PUBLIC

Undocumented
fiftyone.service.ipc.send_request

fiftyone.service.ipc.html#send_request

Function

Function

PUBLIC

Send a request to an IPCServer.
fiftyone.service.main.lock

fiftyone.service.main.html#lock

Attribute

Variable

PUBLIC

Undocumented
fiftyone.service.main.exiting

fiftyone.service.main.html#exiting

Attribute

Variable

PUBLIC

Undocumented
fiftyone.service.main.ExitMode

fiftyone.service.main.ExitMode.html

Class

Class

PUBLIC

Undocumented
fiftyone.service.main.ExitMode.CHILD

fiftyone.service.main.ExitMode.html#CHILD

Attribute

Constant

PUBLIC

Undocumented
fiftyone.service.main.ExitMode.PARENT

fiftyone.service.main.ExitMode.html#PARENT

Attribute

Constant

PUBLIC

Undocumented
fiftyone.service.main.exit_mode

fiftyone.service.main.html#exit_mode

Attribute

Variable

PUBLIC

Undocumented
fiftyone.service.main.trigger_exit

fiftyone.service.main.html#trigger_exit

Function

Function

PUBLIC

Start the shutdown process.
fiftyone.service.main.start_daemon_thread

fiftyone.service.main.html#start_daemon_thread

Function

Function

PUBLIC

Undocumented
fiftyone.service.main.ChildStreamMonitor

fiftyone.service.main.ChildStreamMonitor.html

Class

Class

PUBLIC

Monitor for an output stream (stdout or stderr) of a child process.
fiftyone.service.main.ChildStreamMonitor.__init__

fiftyone.service.main.ChildStreamMonitor.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.service.main.ChildStreamMonitor.stream

fiftyone.service.main.ChildStreamMonitor.html#stream

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.service.main.ChildStreamMonitor.output_deque

fiftyone.service.main.ChildStreamMonitor.html#output_deque

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.service.main.ChildStreamMonitor._run_monitor_thread

fiftyone.service.main.ChildStreamMonitor.html#_run_monitor_thread

Function

Method

PRIVATE

Background task to collect output from the child process.
fiftyone.service.main.ChildStreamMonitor.to_bytes

fiftyone.service.main.ChildStreamMonitor.html#to_bytes

Function

Method

PUBLIC

Return output recently collected from the child process.
fiftyone.service.main.ClientMonitor

fiftyone.service.main.ClientMonitor.html

Class

Class

PUBLIC

Monitor to keep track of all clients using this service.
fiftyone.service.main.ClientMonitor._PARENT

fiftyone.service.main.ClientMonitor.html#_PARENT

Attribute

Constant

PRIVATE

Undocumented
fiftyone.service.main.ClientMonitor.__init__

fiftyone.service.main.ClientMonitor.html#__init__

Function

Method

PUBLIC

Creates and starts a client monitor.
fiftyone.service.main.ClientMonitor.cond

fiftyone.service.main.ClientMonitor.html#cond

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.service.main.ClientMonitor.clients

fiftyone.service.main.ClientMonitor.html#clients

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.service.main.ClientMonitor.thread

fiftyone.service.main.ClientMonitor.html#thread

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.service.main.ClientMonitor.server

fiftyone.service.main.ClientMonitor.html#server

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.service.main.ClientMonitor.notify_parent_exit

fiftyone.service.main.ClientMonitor.html#notify_parent_exit

Function

Method

PUBLIC

Notifies the monitor that the original parent process has exited.
fiftyone.service.main.ClientMonitor._background_loop

fiftyone.service.main.ClientMonitor.html#_background_loop

Function

Method

PRIVATE

Main background loop - waits for all clients to exit, then shuts down the current process.
fiftyone.service.main.ClientMonitor._background_wait

fiftyone.service.main.ClientMonitor.html#_background_wait

Function

Method

PRIVATE

Undocumented
fiftyone.service.main.ClientMonitor._notify_exit

fiftyone.service.main.ClientMonitor.html#_notify_exit

Function

Method

PRIVATE

Notifies _background_loop that a client has exited.
fiftyone.service.main.ClientMonitor._handle_message

fiftyone.service.main.ClientMonitor.html#_handle_message

Function

Method

PRIVATE

Handles an incoming IPC message.
fiftyone.service.main.parser

fiftyone.service.main.html#parser

Attribute

Variable

PUBLIC

Undocumented
fiftyone.service.main.args

fiftyone.service.main.html#args

Attribute

Variable

PUBLIC

Undocumented
fiftyone.service.main.command

fiftyone.service.main.html#command

Attribute

Variable

PUBLIC

Undocumented
fiftyone.service.main.client_monitor

fiftyone.service.main.html#client_monitor

Attribute

Variable

PUBLIC

Undocumented
fiftyone.service.main.popen_kwargs

fiftyone.service.main.html#popen_kwargs

Attribute

Variable

PUBLIC

Undocumented
fiftyone.service.main.child

fiftyone.service.main.html#child

Attribute

Variable

PUBLIC

Undocumented
fiftyone.service.main.child_stdout

fiftyone.service.main.html#child_stdout

Attribute

Variable

PUBLIC

Undocumented
fiftyone.service.main.child_stderr

fiftyone.service.main.html#child_stderr

Attribute

Variable

PUBLIC

Undocumented
fiftyone.service.main.monitor_stdin

fiftyone.service.main.html#monitor_stdin

Function

Function

PUBLIC

Trigger shutdown when the parent process closes this process's stdin. This will occur if the fiftyone.core.service.DatabaseService singleton destroyed.
fiftyone.service.main.shutdown

fiftyone.service.main.html#shutdown

Function

Function

PUBLIC

Kill subprocesses and wait for them to finish.
fiftyone.service.main.stdin_thread

fiftyone.service.main.html#stdin_thread

Attribute

Variable

PUBLIC

Undocumented
fiftyone.service.util.describe_process

fiftyone.service.util.html#describe_process

Function

Function

PUBLIC

Returns a detailed description of a process.
fiftyone.service.util._is_wrapper_process

fiftyone.service.util.html#_is_wrapper_process

Function

Function

PRIVATE

Returns true if the specified process is a wrapper around a single child process with the same arguments.
fiftyone.service.util.normalize_wrapper_process

fiftyone.service.util.html#normalize_wrapper_process

Function

Function

PUBLIC

Returns the given process, or its child if it is a wrapper processes.
fiftyone.service.util.find_processes_by_args

fiftyone.service.util.html#find_processes_by_args

Function

Function

PUBLIC

Finds a process with the specified command-line arguments.
fiftyone.service.util.get_listening_tcp_ports

fiftyone.service.util.html#get_listening_tcp_ports

Function

Function

PUBLIC

Retrieves a list of TCP ports that the specified process is listening on.
fiftyone.service.util.send_ipc_message

fiftyone.service.util.html#send_ipc_message

Function

Function

PUBLIC

Sends a message to a process's IPCServer.
fiftyone.types.dataset_types.Dataset

fiftyone.types.dataset_types.Dataset.html

Class

Class

PUBLIC

Base type for datasets.
fiftyone.types.dataset_types.Dataset.get_dataset_importer_cls

fiftyone.types.dataset_types.Dataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.DatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.Dataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.Dataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.DatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.UnlabeledDataset

fiftyone.types.dataset_types.UnlabeledDataset.html

Class

Class

PUBLIC

Base type for datasets that represent an unlabeled collection of data samples.
fiftyone.types.dataset_types.UnlabeledImageDataset

fiftyone.types.dataset_types.UnlabeledImageDataset.html

Class

Class

PUBLIC

Base type for datasets that represent an unlabeled collection of images.
fiftyone.types.dataset_types.UnlabeledImageDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.UnlabeledImageDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.UnlabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.UnlabeledImageDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.UnlabeledImageDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.UnlabeledVideoDataset

fiftyone.types.dataset_types.UnlabeledVideoDataset.html

Class

Class

PUBLIC

Base type for datasets that represent an unlabeled collection of videos.
fiftyone.types.dataset_types.UnlabeledVideoDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.UnlabeledVideoDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.UnlabeledVideoDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.UnlabeledVideoDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.UnlabeledVideoDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.LabeledDataset

fiftyone.types.dataset_types.LabeledDataset.html

Class

Class

PUBLIC

Base type for datasets that represent a collection of data samples and their associated labels.
fiftyone.types.dataset_types.LabeledImageDataset

fiftyone.types.dataset_types.LabeledImageDataset.html

Class

Class

PUBLIC

Base type for datasets that represent a collection of images and their associated labels.
fiftyone.types.dataset_types.LabeledImageDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.LabeledImageDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.LabeledImageDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.LabeledImageDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.LabeledVideoDataset

fiftyone.types.dataset_types.LabeledVideoDataset.html

Class

Class

PUBLIC

Base type for datasets that represent a collection of videos and their associated labels.
fiftyone.types.dataset_types.LabeledVideoDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.LabeledVideoDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledVideoDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.LabeledVideoDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.LabeledVideoDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledVideoDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.ImageClassificationDataset

fiftyone.types.dataset_types.ImageClassificationDataset.html

Class

Class

PUBLIC

Base type for datasets that represent a collection of images and a set of associated classification labels.
fiftyone.types.dataset_types.VideoClassificationDataset

fiftyone.types.dataset_types.VideoClassificationDataset.html

Class

Class

PUBLIC

Base type for datasets that represent a collection of videos and a set of associated classification labels.
fiftyone.types.dataset_types.ImageDetectionDataset

fiftyone.types.dataset_types.ImageDetectionDataset.html

Class

Class

PUBLIC

Base type for datasets that represent a collection of images and a set of associated detections.
fiftyone.types.dataset_types.VideoDetectionDataset

fiftyone.types.dataset_types.VideoDetectionDataset.html

Class

Class

PUBLIC

Base type for datasets that represent a collection of videos and a set of associated video detections.
fiftyone.types.dataset_types.ImageSegmentationDataset

fiftyone.types.dataset_types.ImageSegmentationDataset.html

Class

Class

PUBLIC

Base type for datasets that represent a collection of images and a set of associated semantic segmentations.
fiftyone.types.dataset_types.ImageLabelsDataset

fiftyone.types.dataset_types.ImageLabelsDataset.html

Class

Class

PUBLIC

Base type for datasets that represent a collection of images and a set of associated multitask predictions.
fiftyone.types.dataset_types.VideoLabelsDataset

fiftyone.types.dataset_types.VideoLabelsDataset.html

Class

Class

PUBLIC

Base type for datasets that represent a collection of videos and a set of associated multitask predictions.
fiftyone.types.dataset_types.GroupDataset

fiftyone.types.dataset_types.GroupDataset.html

Class

Class

PUBLIC

Base type for datasets that contain grouped samples of any type(s).
fiftyone.types.dataset_types.GroupDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.GroupDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.GroupDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.GroupDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.GroupDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.GroupDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.ImageDirectory

fiftyone.types.dataset_types.ImageDirectory.html

Class

Class

PUBLIC

A directory of images.
fiftyone.types.dataset_types.ImageDirectory.get_dataset_importer_cls

fiftyone.types.dataset_types.ImageDirectory.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.UnlabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.ImageDirectory.get_dataset_exporter_cls

fiftyone.types.dataset_types.ImageDirectory.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.VideoDirectory

fiftyone.types.dataset_types.VideoDirectory.html

Class

Class

PUBLIC

A directory of videos.
fiftyone.types.dataset_types.VideoDirectory.get_dataset_importer_cls

fiftyone.types.dataset_types.VideoDirectory.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.UnlabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.VideoDirectory.get_dataset_exporter_cls

fiftyone.types.dataset_types.VideoDirectory.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.MediaDirectory

fiftyone.types.dataset_types.MediaDirectory.html

Class

Class

PUBLIC

A directory of media files.
fiftyone.types.dataset_types.MediaDirectory.get_dataset_importer_cls

fiftyone.types.dataset_types.MediaDirectory.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.DatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.MediaDirectory.get_dataset_exporter_cls

fiftyone.types.dataset_types.MediaDirectory.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.DatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.FiftyOneImageClassificationDataset

fiftyone.types.dataset_types.FiftyOneImageClassificationDataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated classification labels stored in a simple JSON format.
fiftyone.types.dataset_types.FiftyOneImageClassificationDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.FiftyOneImageClassificationDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.FiftyOneImageClassificationDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.FiftyOneImageClassificationDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.ImageClassificationDirectoryTree

fiftyone.types.dataset_types.ImageClassificationDirectoryTree.html

Class

Class

PUBLIC

A directory tree whose subfolders define an image classification dataset.
fiftyone.types.dataset_types.ImageClassificationDirectoryTree.get_dataset_importer_cls

fiftyone.types.dataset_types.ImageClassificationDirectoryTree.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.ImageClassificationDirectoryTree.get_dataset_exporter_cls

fiftyone.types.dataset_types.ImageClassificationDirectoryTree.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.VideoClassificationDirectoryTree

fiftyone.types.dataset_types.VideoClassificationDirectoryTree.html

Class

Class

PUBLIC

A directory tree whose subfolders define a video classification dataset.
fiftyone.types.dataset_types.VideoClassificationDirectoryTree.get_dataset_importer_cls

fiftyone.types.dataset_types.VideoClassificationDirectoryTree.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledVideoDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.VideoClassificationDirectoryTree.get_dataset_exporter_cls

fiftyone.types.dataset_types.VideoClassificationDirectoryTree.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledVideoDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.TFImageClassificationDataset

fiftyone.types.dataset_types.TFImageClassificationDataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated classification labels stored as TFRecords.
fiftyone.types.dataset_types.TFImageClassificationDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.TFImageClassificationDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.TFImageClassificationDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.TFImageClassificationDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.FiftyOneImageDetectionDataset

fiftyone.types.dataset_types.FiftyOneImageDetectionDataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated object detections stored in a simple JSON format.
fiftyone.types.dataset_types.FiftyOneImageDetectionDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.FiftyOneImageDetectionDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.FiftyOneImageDetectionDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.FiftyOneImageDetectionDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.FiftyOneTemporalDetectionDataset

fiftyone.types.dataset_types.FiftyOneTemporalDetectionDataset.html

Class

Class

PUBLIC

A labeled dataset consisting of videos and their associated temporal detections stored in a simple JSON format.
fiftyone.types.dataset_types.FiftyOneTemporalDetectionDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.FiftyOneTemporalDetectionDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledVideoDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.FiftyOneTemporalDetectionDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.FiftyOneTemporalDetectionDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledVideoDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.COCODetectionDataset

fiftyone.types.dataset_types.COCODetectionDataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated object detections saved in COCO Object Detection Format.
fiftyone.types.dataset_types.COCODetectionDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.COCODetectionDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.COCODetectionDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.COCODetectionDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.VOCDetectionDataset

fiftyone.types.dataset_types.VOCDetectionDataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated object detections saved in VOC format.
fiftyone.types.dataset_types.VOCDetectionDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.VOCDetectionDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.VOCDetectionDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.VOCDetectionDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.KITTIDetectionDataset

fiftyone.types.dataset_types.KITTIDetectionDataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated object detections saved in KITTI format.
fiftyone.types.dataset_types.KITTIDetectionDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.KITTIDetectionDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.KITTIDetectionDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.KITTIDetectionDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.OpenImagesV6Dataset

fiftyone.types.dataset_types.OpenImagesV6Dataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated annotations saved in Open Images format.
fiftyone.types.dataset_types.OpenImagesV6Dataset.get_dataset_importer_cls

fiftyone.types.dataset_types.OpenImagesV6Dataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.OpenImagesV7Dataset

fiftyone.types.dataset_types.OpenImagesV7Dataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated annotations saved in Open Images format.
fiftyone.types.dataset_types.OpenImagesV7Dataset.get_dataset_importer_cls

fiftyone.types.dataset_types.OpenImagesV7Dataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.FIWDataset

fiftyone.types.dataset_types.FIWDataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated annotations saved in Families in the Wild format.
fiftyone.types.dataset_types.FIWDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.FIWDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.DatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.OpenLABELImageDataset

fiftyone.types.dataset_types.OpenLABELImageDataset.html

Class

Class

PUBLIC

Undocumented
fiftyone.types.dataset_types.OpenLABELImageDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.OpenLABELImageDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.OpenLABELVideoDataset

fiftyone.types.dataset_types.OpenLABELVideoDataset.html

Class

Class

PUBLIC

Undocumented
fiftyone.types.dataset_types.OpenLABELVideoDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.OpenLABELVideoDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledVideoDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.YOLOv4Dataset

fiftyone.types.dataset_types.YOLOv4Dataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated object detections saved in YOLOv4 format.
fiftyone.types.dataset_types.YOLOv4Dataset.get_dataset_importer_cls

fiftyone.types.dataset_types.YOLOv4Dataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.YOLOv4Dataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.YOLOv4Dataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.YOLOv5Dataset

fiftyone.types.dataset_types.YOLOv5Dataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated object detections saved in YOLOv5 format.
fiftyone.types.dataset_types.YOLOv5Dataset.get_dataset_importer_cls

fiftyone.types.dataset_types.YOLOv5Dataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.YOLOv5Dataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.YOLOv5Dataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.TFObjectDetectionDataset

fiftyone.types.dataset_types.TFObjectDetectionDataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated object detections stored as TFRecords in TF Object Detection API format.
fiftyone.types.dataset_types.TFObjectDetectionDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.TFObjectDetectionDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.TFObjectDetectionDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.TFObjectDetectionDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.ImageSegmentationDirectory

fiftyone.types.dataset_types.ImageSegmentationDirectory.html

Class

Class

PUBLIC

An labeled dataset consisting of images and their associated semantic segmentations stored as images on disk.
fiftyone.types.dataset_types.ImageSegmentationDirectory.get_dataset_importer_cls

fiftyone.types.dataset_types.ImageSegmentationDirectory.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.ImageSegmentationDirectory.get_dataset_exporter_cls

fiftyone.types.dataset_types.ImageSegmentationDirectory.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.CVATImageDataset

fiftyone.types.dataset_types.CVATImageDataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated labels stored in CVAT image format.
fiftyone.types.dataset_types.CVATImageDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.CVATImageDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.CVATImageDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.CVATImageDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.CVATVideoDataset

fiftyone.types.dataset_types.CVATVideoDataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated object detections stored in CVAT video format.
fiftyone.types.dataset_types.CVATVideoDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.CVATVideoDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledVideoDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.CVATVideoDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.CVATVideoDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledVideoDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.FiftyOneImageLabelsDataset

fiftyone.types.dataset_types.FiftyOneImageLabelsDataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated multitask predictions stored in ETA ImageLabels format.
fiftyone.types.dataset_types.FiftyOneImageLabelsDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.FiftyOneImageLabelsDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.FiftyOneImageLabelsDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.FiftyOneImageLabelsDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.FiftyOneVideoLabelsDataset

fiftyone.types.dataset_types.FiftyOneVideoLabelsDataset.html

Class

Class

PUBLIC

A labeled dataset consisting of videos and their associated labels stored in ETA VideoLabels format.
fiftyone.types.dataset_types.FiftyOneVideoLabelsDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.FiftyOneVideoLabelsDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledVideoDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.FiftyOneVideoLabelsDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.FiftyOneVideoLabelsDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledVideoDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.BDDDataset

fiftyone.types.dataset_types.BDDDataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated multitask predictions saved in Berkeley DeepDrive (BDD) format.
fiftyone.types.dataset_types.BDDDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.BDDDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.BDDDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.BDDDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.LabeledImageDatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.DICOMDataset

fiftyone.types.dataset_types.DICOMDataset.html

Class

Class

PUBLIC

An image dataset whose image data and optional properties are stored in DICOM format.
fiftyone.types.dataset_types.DICOMDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.DICOMDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.ActivityNetDataset

fiftyone.types.dataset_types.ActivityNetDataset.html

Class

Class

PUBLIC

A video dataset composed of temporal activity detections from the ActivityNet dataset.
fiftyone.types.dataset_types.ActivityNetDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.ActivityNetDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledVideoDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.GeoJSONDataset

fiftyone.types.dataset_types.GeoJSONDataset.html

Class

Class

PUBLIC

An image or video dataset whose geolocation data and optional properties are stored in GeoJSON format.
fiftyone.types.dataset_types.GeoJSONDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.GeoJSONDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.DatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.GeoJSONDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.GeoJSONDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.DatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.GeoTIFFDataset

fiftyone.types.dataset_types.GeoTIFFDataset.html

Class

Class

PUBLIC

An image dataset whose image and geolocation data are stored in GeoTIFF format.
fiftyone.types.dataset_types.GeoTIFFDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.GeoTIFFDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.CSVDataset

fiftyone.types.dataset_types.CSVDataset.html

Class

Class

PUBLIC

A flexible CSV format that represents slice(s) of field values of a dataset as columns of a CSV file.
fiftyone.types.dataset_types.CSVDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.CSVDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.DatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.CSVDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.CSVDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.DatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.FiftyOneDataset

fiftyone.types.dataset_types.FiftyOneDataset.html

Class

Class

PUBLIC

A disk representation of an entire fiftyone.core.dataset.Dataset stored on disk in a serialized JSON format along with its source media.
fiftyone.types.dataset_types.FiftyOneDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.FiftyOneDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.DatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.FiftyOneDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.FiftyOneDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.DatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.LegacyFiftyOneDataset

fiftyone.types.dataset_types.LegacyFiftyOneDataset.html

Class

Class

PUBLIC

Legacy disk representation of an entire fiftyone.core.dataset.Dataset stored on disk in a serialized JSON format along with its source media.
fiftyone.types.dataset_types.LegacyFiftyOneDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.LegacyFiftyOneDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.DatasetImporter class for importing datasets of this type from disk.
fiftyone.types.dataset_types.LegacyFiftyOneDataset.get_dataset_exporter_cls

fiftyone.types.dataset_types.LegacyFiftyOneDataset.html#get_dataset_exporter_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.exporters.DatasetExporter class for exporting datasets of this type to disk.
fiftyone.types.dataset_types.PlacesDataset

fiftyone.types.dataset_types.PlacesDataset.html

Class

Class

PUBLIC

A labeled dataset consisting of images and their associated lables from the Places dataset.
fiftyone.types.dataset_types.PlacesDataset.get_dataset_importer_cls

fiftyone.types.dataset_types.PlacesDataset.html#get_dataset_importer_cls

Function

Method

PUBLIC

Returns the fiftyone.utils.data.importers.LabeledImageDatasetImporter class for importing datasets of this type from disk.
fiftyone.utils.activitynet.logger

fiftyone.utils.activitynet.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.download_activitynet_split

fiftyone.utils.activitynet.html#download_activitynet_split

Function

Function

PUBLIC

Utility that downloads full or partial splits of the ActivityNet dataset.
fiftyone.utils.activitynet.ActivityNetDatasetImporter

fiftyone.utils.activitynet.ActivityNetDatasetImporter.html

Class

Class

PUBLIC

Class for importing AcitivityNet dataset splits downloaded via download_activitynet_split.
fiftyone.utils.activitynet.ActivityNetDatasetImporter.data_path

fiftyone.utils.activitynet.ActivityNetDatasetImporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetImporter.classes

fiftyone.utils.activitynet.ActivityNetDatasetImporter.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetImporter.max_duration

fiftyone.utils.activitynet.ActivityNetDatasetImporter.html#max_duration

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetImporter.__init__

fiftyone.utils.activitynet.ActivityNetDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetImporter._taxonomy

fiftyone.utils.activitynet.ActivityNetDatasetImporter.html#_taxonomy

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetImporter.has_dataset_info

fiftyone.utils.activitynet.ActivityNetDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.activitynet.ActivityNetDatasetImporter.setup

fiftyone.utils.activitynet.ActivityNetDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.activitynet.ActivityNetDatasetImporter._video_paths_map

fiftyone.utils.activitynet.ActivityNetDatasetImporter.html#_video_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetImporter._sample_parser

fiftyone.utils.activitynet.ActivityNetDatasetImporter.html#_sample_parser

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetImporter._uuids

fiftyone.utils.activitynet.ActivityNetDatasetImporter.html#_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetImporter._classes

fiftyone.utils.activitynet.ActivityNetDatasetImporter.html#_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetImporter._labels_map

fiftyone.utils.activitynet.ActivityNetDatasetImporter.html#_labels_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetImporter._has_labels

fiftyone.utils.activitynet.ActivityNetDatasetImporter.html#_has_labels

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetImporter._num_samples

fiftyone.utils.activitynet.ActivityNetDatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetImporter.get_dataset_info

fiftyone.utils.activitynet.ActivityNetDatasetImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.activitynet.ActivityNetDownloadConfig

fiftyone.utils.activitynet.ActivityNetDownloadConfig.html

Class

Class

PUBLIC

Configuration class for downloading full or partial splits from the ActivityNet dataset.
fiftyone.utils.activitynet.ActivityNetDownloadConfig.__init__

fiftyone.utils.activitynet.ActivityNetDownloadConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDownloadConfig.split

fiftyone.utils.activitynet.ActivityNetDownloadConfig.html#split

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDownloadConfig.source_dir

fiftyone.utils.activitynet.ActivityNetDownloadConfig.html#source_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDownloadConfig.classes

fiftyone.utils.activitynet.ActivityNetDownloadConfig.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDownloadConfig.max_duration

fiftyone.utils.activitynet.ActivityNetDownloadConfig.html#max_duration

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDownloadConfig.copy_files

fiftyone.utils.activitynet.ActivityNetDownloadConfig.html#copy_files

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDownloadConfig.num_workers

fiftyone.utils.activitynet.ActivityNetDownloadConfig.html#num_workers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDownloadConfig.shuffle

fiftyone.utils.activitynet.ActivityNetDownloadConfig.html#shuffle

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDownloadConfig.seed

fiftyone.utils.activitynet.ActivityNetDownloadConfig.html#seed

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDownloadConfig.max_samples

fiftyone.utils.activitynet.ActivityNetDownloadConfig.html#max_samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDownloadConfig.load_entire_split

fiftyone.utils.activitynet.ActivityNetDownloadConfig.html#load_entire_split

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDownloadConfig.validate

fiftyone.utils.activitynet.ActivityNetDownloadConfig.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDownloadConfig.validate_split

fiftyone.utils.activitynet.ActivityNetDownloadConfig.html#validate_split

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDownloadConfig.validate_max_duration

fiftyone.utils.activitynet.ActivityNetDownloadConfig.html#validate_max_duration

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager

fiftyone.utils.activitynet.ActivityNetDatasetManager.html

Class

Class

PUBLIC

Class that manages the sample IDs and labels that need to be downloaded to load the specified subset of an ActivityNet dataset.
fiftyone.utils.activitynet.ActivityNetDatasetManager.__init__

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager.version

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#version

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager.a100_info

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#a100_info

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager.a200_info

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#a200_info

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager.info

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#info

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager.all_classes

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#all_classes

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager.existing_split_sample_ids

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#existing_split_sample_ids

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager.split_sample_ids

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#split_sample_ids

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager.process_source

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#process_source

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager._process_source_zip

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#_process_source_zip

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager._check_zip_requirement

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#_check_zip_requirement

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager._split_is_missing_videos

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#_split_is_missing_videos

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager._process_source_dir

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#_process_source_dir

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager._process_files

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#_process_files

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager._get_video_destination

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#_get_video_destination

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager.download_necessary_samples

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#download_necessary_samples

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager._load_requested_samples

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#_load_requested_samples

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager._download_requested_samples

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#_download_requested_samples

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager._separate_versions_and_attempt_to_download

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#_separate_versions_and_attempt_to_download

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager._attempt_to_download

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#_attempt_to_download

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager._merge_and_write_errors

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#_merge_and_write_errors

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager.write_data_json

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#write_data_json

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager._data_map

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#_data_map

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetManager.from_dataset_dir

fiftyone.utils.activitynet.ActivityNetDatasetManager.html#from_dataset_dir

Function

Class Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetInfo

fiftyone.utils.activitynet.ActivityNetInfo.html

Class

Class

PUBLIC

Necessary information used to parse and format annotations.
fiftyone.utils.activitynet.ActivityNetInfo.__init__

fiftyone.utils.activitynet.ActivityNetInfo.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetInfo.raw_annotations

fiftyone.utils.activitynet.ActivityNetInfo.html#raw_annotations

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetInfo.taxonomy

fiftyone.utils.activitynet.ActivityNetInfo.html#taxonomy

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetInfo.all_classes

fiftyone.utils.activitynet.ActivityNetInfo.html#all_classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetInfo._splitwise_sample_ids

fiftyone.utils.activitynet.ActivityNetInfo.html#_splitwise_sample_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetInfo.all_sample_ids

fiftyone.utils.activitynet.ActivityNetInfo.html#all_sample_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetInfo._parse_sample_ids

fiftyone.utils.activitynet.ActivityNetInfo.html#_parse_sample_ids

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetInfo.get_matching_samples

fiftyone.utils.activitynet.ActivityNetInfo.html#get_matching_samples

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetInfo._parse_classes

fiftyone.utils.activitynet.ActivityNetInfo.html#_parse_classes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetInfo.format_annotations

fiftyone.utils.activitynet.ActivityNetInfo.html#format_annotations

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetSplitInfo

fiftyone.utils.activitynet.ActivityNetSplitInfo.html

Class

Class

PUBLIC

Class that contains information related to paths, labels, and sample IDs of a single ActivityNet split.
fiftyone.utils.activitynet.ActivityNetSplitInfo.__init__

fiftyone.utils.activitynet.ActivityNetSplitInfo.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetSplitInfo.split_dir

fiftyone.utils.activitynet.ActivityNetSplitInfo.html#split_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetSplitInfo.raw_annotations

fiftyone.utils.activitynet.ActivityNetSplitInfo.html#raw_annotations

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetSplitInfo.raw_anno_path

fiftyone.utils.activitynet.ActivityNetSplitInfo.html#raw_anno_path

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetSplitInfo.data_dir

fiftyone.utils.activitynet.ActivityNetSplitInfo.html#data_dir

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetSplitInfo.data_json_path

fiftyone.utils.activitynet.ActivityNetSplitInfo.html#data_json_path

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetSplitInfo.error_path

fiftyone.utils.activitynet.ActivityNetSplitInfo.html#error_path

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetSplitInfo.update_existing_sample_ids

fiftyone.utils.activitynet.ActivityNetSplitInfo.html#update_existing_sample_ids

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetSplitInfo.existing_sample_ids

fiftyone.utils.activitynet.ActivityNetSplitInfo.html#existing_sample_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetSplitInfo._get_video_files

fiftyone.utils.activitynet.ActivityNetSplitInfo.html#_get_video_files

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetSplitInfo.cleanup

fiftyone.utils.activitynet.ActivityNetSplitInfo.html#cleanup

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetSplitInfo._get_raw_annotations

fiftyone.utils.activitynet.ActivityNetSplitInfo.html#_get_raw_annotations

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html

Class

Class

PUBLIC

Class that stores information related to paths, labels, and sample IDs for an ActivityNet dataset download.
fiftyone.utils.activitynet.ActivityNetDatasetInfo.__init__

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.foz_dir

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#foz_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo._split_infos

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#_split_infos

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.raw_annotations

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#raw_annotations

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.split_info

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#split_info

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.splits

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#splits

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.version

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#version

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.dataset_dir

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#dataset_dir

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.raw_anno_path

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#raw_anno_path

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.split_sample_ids

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#split_sample_ids

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.existing_split_sample_ids

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#existing_split_sample_ids

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.split_dir

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#split_dir

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.data_dir

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#data_dir

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.data_json_path

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#data_json_path

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.error_path

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#error_path

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.update_existing_sample_ids

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#update_existing_sample_ids

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo._splitwise_existing_sample_ids

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#_splitwise_existing_sample_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.existing_sample_ids

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#existing_sample_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo._get_existing_sample_ids

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#_get_existing_sample_ids

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.cleanup_split

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#cleanup_split

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo._get_raw_annotations

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#_get_raw_annotations

Function

Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.get_dir_info

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#get_dir_info

Function

Class Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo._get_version_from_dirname

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#_get_version_from_dirname

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.get_sample_split

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#get_sample_split

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNetDatasetInfo.get_sample_dataset_version

fiftyone.utils.activitynet.ActivityNetDatasetInfo.html#get_sample_dataset_version

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNet100DatasetInfo

fiftyone.utils.activitynet.ActivityNet100DatasetInfo.html

Class

Class

PUBLIC

ActivityNet 100 dataset info.
fiftyone.utils.activitynet.ActivityNet100DatasetInfo.version

fiftyone.utils.activitynet.ActivityNet100DatasetInfo.html#version

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNet100DatasetInfo.get_sample_dataset_version

fiftyone.utils.activitynet.ActivityNet100DatasetInfo.html#get_sample_dataset_version

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNet100DatasetInfo.update_existing_sample_ids

fiftyone.utils.activitynet.ActivityNet100DatasetInfo.html#update_existing_sample_ids

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNet100DatasetInfo._splitwise_existing_sample_ids

fiftyone.utils.activitynet.ActivityNet100DatasetInfo.html#_splitwise_existing_sample_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNet100DatasetInfo.existing_sample_ids

fiftyone.utils.activitynet.ActivityNet100DatasetInfo.html#existing_sample_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNet200DatasetInfo

fiftyone.utils.activitynet.ActivityNet200DatasetInfo.html

Class

Class

PUBLIC

ActivityNet 200 dataset info.
fiftyone.utils.activitynet.ActivityNet200DatasetInfo.__init__

fiftyone.utils.activitynet.ActivityNet200DatasetInfo.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNet200DatasetInfo.a100_info

fiftyone.utils.activitynet.ActivityNet200DatasetInfo.html#a100_info

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNet200DatasetInfo.version

fiftyone.utils.activitynet.ActivityNet200DatasetInfo.html#version

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNet200DatasetInfo.get_sample_dataset_version

fiftyone.utils.activitynet.ActivityNet200DatasetInfo.html#get_sample_dataset_version

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNet200DatasetInfo.update_existing_sample_ids

fiftyone.utils.activitynet.ActivityNet200DatasetInfo.html#update_existing_sample_ids

Function

Method

PUBLIC

Undocumented
fiftyone.utils.activitynet.ActivityNet200DatasetInfo._splitwise_existing_sample_ids

fiftyone.utils.activitynet.ActivityNet200DatasetInfo.html#_splitwise_existing_sample_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.activitynet.ActivityNet200DatasetInfo.existing_sample_ids

fiftyone.utils.activitynet.ActivityNet200DatasetInfo.html#existing_sample_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.activitynet._get_all_classes

fiftyone.utils.activitynet.html#_get_all_classes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.activitynet._flatten_list

fiftyone.utils.activitynet.html#_flatten_list

Function

Function

PRIVATE

Undocumented
fiftyone.utils.activitynet._ANNOTATION_DOWNLOAD_LINKS

fiftyone.utils.activitynet.html#_ANNOTATION_DOWNLOAD_LINKS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.activitynet._SPLIT_MAP

fiftyone.utils.activitynet.html#_SPLIT_MAP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.activitynet._SPLIT_MAP_REV

fiftyone.utils.activitynet.html#_SPLIT_MAP_REV

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.activitynet._NUM_TOTAL_SAMPLES

fiftyone.utils.activitynet.html#_NUM_TOTAL_SAMPLES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.activitynet._SOURCE_ZIPS

fiftyone.utils.activitynet.html#_SOURCE_ZIPS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.activitynet._SOURCE_DIR_NAMES

fiftyone.utils.activitynet.html#_SOURCE_DIR_NAMES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.annotations.logger

fiftyone.utils.annotations.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.annotations.connect_to_api

fiftyone.utils.annotations.html#connect_to_api

Function

Function

PUBLIC

Returns an API instance connected to the annotation backend.
fiftyone.utils.annotations.annotate

fiftyone.utils.annotations.html#annotate

Function

Function

PUBLIC

Exports the samples and optional label field(s) to the given annotation backend.
fiftyone.utils.annotations._get_patches_view_label_ids

fiftyone.utils.annotations.html#_get_patches_view_label_ids

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._parse_config

fiftyone.utils.annotations.html#_parse_config

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._LABEL_TYPES_MAP

fiftyone.utils.annotations.html#_LABEL_TYPES_MAP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.annotations._RETURN_TYPES_MAP

fiftyone.utils.annotations.html#_RETURN_TYPES_MAP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.annotations._DEFAULT_LABEL_FIELDS_MAP

fiftyone.utils.annotations.html#_DEFAULT_LABEL_FIELDS_MAP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.annotations._SPATIAL_LABEL_FIELDS_MAP

fiftyone.utils.annotations.html#_SPATIAL_LABEL_FIELDS_MAP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.annotations._TRACKABLE_TYPES

fiftyone.utils.annotations.html#_TRACKABLE_TYPES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.annotations._LABEL_TYPES

fiftyone.utils.annotations.html#_LABEL_TYPES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.annotations._SPATIAL_TYPES

fiftyone.utils.annotations.html#_SPATIAL_TYPES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.annotations._build_label_schema

fiftyone.utils.annotations.html#_build_label_schema

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._select_labels_with_type

fiftyone.utils.annotations.html#_select_labels_with_type

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._init_label_schema

fiftyone.utils.annotations.html#_init_label_schema

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._get_label_type

fiftyone.utils.annotations.html#_get_label_type

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._to_list

fiftyone.utils.annotations.html#_to_list

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._flatten_list

fiftyone.utils.annotations.html#_flatten_list

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._unwrap

fiftyone.utils.annotations.html#_unwrap

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._get_backend_field_type

fiftyone.utils.annotations.html#_get_backend_field_type

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._get_classes

fiftyone.utils.annotations.html#_get_classes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._parse_classes_dict

fiftyone.utils.annotations.html#_parse_classes_dict

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._get_mask_targets

fiftyone.utils.annotations.html#_get_mask_targets

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._get_attributes

fiftyone.utils.annotations.html#_get_attributes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._get_label_attributes

fiftyone.utils.annotations.html#_get_label_attributes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._is_trackable_field

fiftyone.utils.annotations.html#_is_trackable_field

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._format_attributes

fiftyone.utils.annotations.html#_format_attributes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations.load_annotations

fiftyone.utils.annotations.html#load_annotations

Function

Function

PUBLIC

Downloads the labels from the given annotation run from the annotation backend and merges them into the collection.
fiftyone.utils.annotations._handle_frame_fields

fiftyone.utils.annotations.html#_handle_frame_fields

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._parse_attributes

fiftyone.utils.annotations.html#_parse_attributes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._get_writeable_attributes

fiftyone.utils.annotations.html#_get_writeable_attributes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._prompt_field

fiftyone.utils.annotations.html#_prompt_field

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._merge_scalars

fiftyone.utils.annotations.html#_merge_scalars

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._merge_labels

fiftyone.utils.annotations.html#_merge_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._ensure_label_field

fiftyone.utils.annotations.html#_ensure_label_field

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._merge_label

fiftyone.utils.annotations.html#_merge_label

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._update_tracks

fiftyone.utils.annotations.html#_update_tracks

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations.AnnotationBackendConfig

fiftyone.utils.annotations.AnnotationBackendConfig.html

Class

Class

PUBLIC

Base class for configuring an AnnotationBackend instances.
fiftyone.utils.annotations.AnnotationBackendConfig.media_field

fiftyone.utils.annotations.AnnotationBackendConfig.html#media_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.annotations.AnnotationBackendConfig.__init__

fiftyone.utils.annotations.AnnotationBackendConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.annotations.AnnotationBackendConfig.name

fiftyone.utils.annotations.AnnotationBackendConfig.html#name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.annotations.AnnotationBackendConfig.label_schema

fiftyone.utils.annotations.AnnotationBackendConfig.html#label_schema

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.annotations.AnnotationBackendConfig.method

fiftyone.utils.annotations.AnnotationBackendConfig.html#method

Attribute

Property

PUBLIC

The name of the annotation backend.
fiftyone.utils.annotations.AnnotationBackendConfig.load_credentials

fiftyone.utils.annotations.AnnotationBackendConfig.html#load_credentials

Function

Method

PUBLIC

Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config.
fiftyone.utils.annotations.AnnotationBackendConfig._load_parameters

fiftyone.utils.annotations.AnnotationBackendConfig.html#_load_parameters

Function

Method

PRIVATE

Undocumented
fiftyone.utils.annotations.AnnotationBackendConfig._sanitize_label_schema

fiftyone.utils.annotations.AnnotationBackendConfig.html#_sanitize_label_schema

Function

Method

PRIVATE

Undocumented
fiftyone.utils.annotations.AnnotationBackendConfig.serialize

fiftyone.utils.annotations.AnnotationBackendConfig.html#serialize

Function

Method

PUBLIC

Undocumented
fiftyone.utils.annotations.AnnotationBackend

fiftyone.utils.annotations.AnnotationBackend.html

Class

Class

PUBLIC

Base class for annotation backends.
fiftyone.utils.annotations.AnnotationBackend.__init__

fiftyone.utils.annotations.AnnotationBackend.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.annotations.AnnotationBackend._api

fiftyone.utils.annotations.AnnotationBackend.html#_api

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.annotations.AnnotationBackend.__enter__

fiftyone.utils.annotations.AnnotationBackend.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.annotations.AnnotationBackend.__exit__

fiftyone.utils.annotations.AnnotationBackend.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.annotations.AnnotationBackend.supported_media_types

fiftyone.utils.annotations.AnnotationBackend.html#supported_media_types

Attribute

Property

PUBLIC

The list of media types that this backend supports.
fiftyone.utils.annotations.AnnotationBackend.supported_label_types

fiftyone.utils.annotations.AnnotationBackend.html#supported_label_types

Attribute

Property

PUBLIC

The list of label types supported by the backend.
fiftyone.utils.annotations.AnnotationBackend.supported_scalar_types

fiftyone.utils.annotations.AnnotationBackend.html#supported_scalar_types

Attribute

Property

PUBLIC

The list of scalar field types supported by the backend.
fiftyone.utils.annotations.AnnotationBackend.supported_attr_types

fiftyone.utils.annotations.AnnotationBackend.html#supported_attr_types

Attribute

Property

PUBLIC

The list of attribute types supported by the backend.
fiftyone.utils.annotations.AnnotationBackend.supports_clips_views

fiftyone.utils.annotations.AnnotationBackend.html#supports_clips_views

Attribute

Property

PUBLIC

Whether this backend supports annotating clips views.
fiftyone.utils.annotations.AnnotationBackend.supports_keyframes

fiftyone.utils.annotations.AnnotationBackend.html#supports_keyframes

Attribute

Property

PUBLIC

Whether this backend supports uploading only keyframes when editing existing video track annotations.
fiftyone.utils.annotations.AnnotationBackend.supports_video_sample_fields

fiftyone.utils.annotations.AnnotationBackend.html#supports_video_sample_fields

Attribute

Property

PUBLIC

Whether this backend supports annotating video labels at a sample-level.
fiftyone.utils.annotations.AnnotationBackend.requires_label_schema

fiftyone.utils.annotations.AnnotationBackend.html#requires_label_schema

Attribute

Property

PUBLIC

Whether this backend requires a pre-defined label schema for its annotation runs.
fiftyone.utils.annotations.AnnotationBackend.recommend_attr_tool

fiftyone.utils.annotations.AnnotationBackend.html#recommend_attr_tool

Function

Method

PUBLIC

Recommends an attribute tool for an attribute with the given name and value.
fiftyone.utils.annotations.AnnotationBackend.requires_attr_values

fiftyone.utils.annotations.AnnotationBackend.html#requires_attr_values

Function

Method

PUBLIC

Determines whether the list of possible values are required for attributes of the given type.
fiftyone.utils.annotations.AnnotationBackend.connect_to_api

fiftyone.utils.annotations.AnnotationBackend.html#connect_to_api

Function

Method

PUBLIC

Returns an API instance connected to the annotation backend.
fiftyone.utils.annotations.AnnotationBackend._connect_to_api

fiftyone.utils.annotations.AnnotationBackend.html#_connect_to_api

Function

Method

PRIVATE

Returns a new API instance connected to the annotation backend.
fiftyone.utils.annotations.AnnotationBackend.use_api

fiftyone.utils.annotations.AnnotationBackend.html#use_api

Function

Method

PUBLIC

Registers an API instance to use for subsequent operations.
fiftyone.utils.annotations.AnnotationBackend.upload_annotations

fiftyone.utils.annotations.AnnotationBackend.html#upload_annotations

Function

Method

PUBLIC

Uploads the samples and relevant existing labels from the label schema to the annotation backend.
fiftyone.utils.annotations.AnnotationBackend.download_annotations

fiftyone.utils.annotations.AnnotationBackend.html#download_annotations

Function

Method

PUBLIC

Downloads the annotations from the annotation backend for the given results.
fiftyone.utils.annotations.AnnotationBackend.get_fields

fiftyone.utils.annotations.AnnotationBackend.html#get_fields

Function

Method

PUBLIC

Gets the fields that were involved in the given run.
fiftyone.utils.annotations.AnnotationResults

fiftyone.utils.annotations.AnnotationResults.html

Class

Class

PUBLIC

Base class for storing the intermediate results of an annotation run that has been initiated and is waiting for its results to be merged back into the FiftyOne dataset.
fiftyone.utils.annotations.AnnotationResults.__init__

fiftyone.utils.annotations.AnnotationResults.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.annotations.AnnotationResults.id_map

fiftyone.utils.annotations.AnnotationResults.html#id_map

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.annotations.AnnotationResults.__enter__

fiftyone.utils.annotations.AnnotationResults.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.annotations.AnnotationResults.__exit__

fiftyone.utils.annotations.AnnotationResults.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.annotations.AnnotationResults.connect_to_api

fiftyone.utils.annotations.AnnotationResults.html#connect_to_api

Function

Method

PUBLIC

Returns an API instance connected to the annotation backend.
fiftyone.utils.annotations.AnnotationResults.use_api

fiftyone.utils.annotations.AnnotationResults.html#use_api

Function

Method

PUBLIC

Registers an API instance to use for subsequent operations.
fiftyone.utils.annotations.AnnotationResults.launch_editor

fiftyone.utils.annotations.AnnotationResults.html#launch_editor

Function

Method

PUBLIC

Launches the annotation backend's editor for these results.
fiftyone.utils.annotations.AnnotationResults.cleanup

fiftyone.utils.annotations.AnnotationResults.html#cleanup

Function

Method

PUBLIC

Deletes all information for this run from the annotation backend.
fiftyone.utils.annotations.AnnotationResults._is_clips

fiftyone.utils.annotations.AnnotationResults.html#_is_clips

Attribute

Property

PRIVATE

Whether this annotation run was perfromed on a clips view.
fiftyone.utils.annotations.AnnotationResults._is_frames

fiftyone.utils.annotations.AnnotationResults.html#_is_frames

Attribute

Property

PRIVATE

Whether this annotation run was perfromed on a frames view.
fiftyone.utils.annotations.AnnotationResults._finalize_id_map

fiftyone.utils.annotations.AnnotationResults.html#_finalize_id_map

Function

Method

PRIVATE

Internal method that is (only) called prior to saving annotation results for the first time.
fiftyone.utils.annotations.AnnotationResults._update_id_map

fiftyone.utils.annotations.AnnotationResults.html#_update_id_map

Function

Method

PRIVATE

Adds the given label IDs into this object's id_map.
fiftyone.utils.annotations.AnnotationResults._to_sample_ids

fiftyone.utils.annotations.AnnotationResults.html#_to_sample_ids

Function

Method

PRIVATE

Undocumented
fiftyone.utils.annotations.AnnotationResults._sample_ids_to_clip_ids

fiftyone.utils.annotations.AnnotationResults.html#_sample_ids_to_clip_ids

Function

Method

PRIVATE

Undocumented
fiftyone.utils.annotations.AnnotationResults._to_sample_annos

fiftyone.utils.annotations.AnnotationResults.html#_to_sample_annos

Function

Method

PRIVATE

Undocumented
fiftyone.utils.annotations.AnnotationResults._format_label_ids

fiftyone.utils.annotations.AnnotationResults.html#_format_label_ids

Function

Method

PRIVATE

Undocumented
fiftyone.utils.annotations.AnnotationResults._from_dict

fiftyone.utils.annotations.AnnotationResults.html#_from_dict

Function

Class Method

PRIVATE

Builds an AnnotationResults from a JSON dict representation of it.
fiftyone.utils.annotations.AnnotationAPI

fiftyone.utils.annotations.AnnotationAPI.html

Class

Class

PUBLIC

Base class for APIs that connect to annotation backends.
fiftyone.utils.annotations.AnnotationAPI.__enter__

fiftyone.utils.annotations.AnnotationAPI.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.annotations.AnnotationAPI.__exit__

fiftyone.utils.annotations.AnnotationAPI.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.annotations.AnnotationAPI.close

fiftyone.utils.annotations.AnnotationAPI.html#close

Function

Method

PUBLIC

Closes the API session.
fiftyone.utils.annotations.AnnotationAPI._prompt_username_password

fiftyone.utils.annotations.AnnotationAPI.html#_prompt_username_password

Function

Method

PRIVATE

Undocumented
fiftyone.utils.annotations.AnnotationAPI._prompt_api_key

fiftyone.utils.annotations.AnnotationAPI.html#_prompt_api_key

Function

Method

PRIVATE

Undocumented
fiftyone.utils.annotations.DrawConfig

fiftyone.utils.annotations.DrawConfig.html

Class

Class

PUBLIC

No summary
fiftyone.utils.annotations.DrawConfig.__init__

fiftyone.utils.annotations.DrawConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.annotations.draw_labeled_images

fiftyone.utils.annotations.html#draw_labeled_images

Function

Function

PUBLIC

Renders annotated versions of the images in the collection with the specified label data overlaid to the given directory.
fiftyone.utils.annotations.draw_labeled_image

fiftyone.utils.annotations.html#draw_labeled_image

Function

Function

PUBLIC

Renders an annotated version of the sample's image with the specified label data overlaid to disk.
fiftyone.utils.annotations.draw_labeled_videos

fiftyone.utils.annotations.html#draw_labeled_videos

Function

Function

PUBLIC

Renders annotated versions of the videos in the collection with the specified label data overlaid to the given directory.
fiftyone.utils.annotations.draw_labeled_video

fiftyone.utils.annotations.html#draw_labeled_video

Function

Function

PUBLIC

Renders an annotated version of the sample's video with the specified label data overlaid to disk.
fiftyone.utils.annotations._parse_draw_config

fiftyone.utils.annotations.html#_parse_draw_config

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._get_skeleton

fiftyone.utils.annotations.html#_get_skeleton

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._to_image_labels

fiftyone.utils.annotations.html#_to_image_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._to_video_labels

fiftyone.utils.annotations.html#_to_video_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._get_sample_labels

fiftyone.utils.annotations.html#_get_sample_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.annotations._get_frame_labels

fiftyone.utils.annotations.html#_get_frame_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.aws.logger

fiftyone.utils.aws.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.aws.download_public_s3_files

fiftyone.utils.aws.html#download_public_s3_files

Function

Function

PUBLIC

Download files from a public AWS S3 bucket using unsigned URLs.
fiftyone.utils.aws._build_inputs

fiftyone.utils.aws.html#_build_inputs

Function

Function

PRIVATE

Undocumented
fiftyone.utils.aws._parse_url

fiftyone.utils.aws.html#_parse_url

Function

Function

PRIVATE

Undocumented
fiftyone.utils.aws._single_thread_download

fiftyone.utils.aws.html#_single_thread_download

Function

Function

PRIVATE

Undocumented
fiftyone.utils.aws._multi_thread_download

fiftyone.utils.aws.html#_multi_thread_download

Function

Function

PRIVATE

Undocumented
fiftyone.utils.aws._do_s3_download

fiftyone.utils.aws.html#_do_s3_download

Function

Function

PRIVATE

Undocumented
fiftyone.utils.bdd.logger

fiftyone.utils.bdd.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.bdd.BDDDatasetImporter

fiftyone.utils.bdd.BDDDatasetImporter.html

Class

Class

PUBLIC

Importer for BDD datasets stored on disk.
fiftyone.utils.bdd.BDDDatasetImporter.data_path

fiftyone.utils.bdd.BDDDatasetImporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.bdd.BDDDatasetImporter.labels_path

fiftyone.utils.bdd.BDDDatasetImporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.bdd.BDDDatasetImporter.include_all_data

fiftyone.utils.bdd.BDDDatasetImporter.html#include_all_data

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.bdd.BDDDatasetImporter.extra_attrs

fiftyone.utils.bdd.BDDDatasetImporter.html#extra_attrs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.bdd.BDDDatasetImporter.__init__

fiftyone.utils.bdd.BDDDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.bdd.BDDDatasetImporter._image_paths_map

fiftyone.utils.bdd.BDDDatasetImporter.html#_image_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.bdd.BDDDatasetImporter._anno_dict_map

fiftyone.utils.bdd.BDDDatasetImporter.html#_anno_dict_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.bdd.BDDDatasetImporter._filenames

fiftyone.utils.bdd.BDDDatasetImporter.html#_filenames

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.bdd.BDDDatasetImporter._iter_filenames

fiftyone.utils.bdd.BDDDatasetImporter.html#_iter_filenames

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.bdd.BDDDatasetImporter._num_samples

fiftyone.utils.bdd.BDDDatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.bdd.BDDDatasetImporter.__iter__

fiftyone.utils.bdd.BDDDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.bdd.BDDDatasetImporter.__len__

fiftyone.utils.bdd.BDDDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.bdd.BDDDatasetImporter.__next__

fiftyone.utils.bdd.BDDDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.bdd.BDDDatasetImporter.has_dataset_info

fiftyone.utils.bdd.BDDDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.bdd.BDDDatasetImporter.has_image_metadata

fiftyone.utils.bdd.BDDDatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.bdd.BDDDatasetImporter.label_cls

fiftyone.utils.bdd.BDDDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.bdd.BDDDatasetImporter.setup

fiftyone.utils.bdd.BDDDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.bdd.BDDDatasetImporter._get_num_samples

fiftyone.utils.bdd.BDDDatasetImporter.html#_get_num_samples

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.bdd.BDDDatasetExporter

fiftyone.utils.bdd.BDDDatasetExporter.html

Class

Class

PUBLIC

Exporter that writes BDD datasets to disk.
fiftyone.utils.bdd.BDDDatasetExporter.data_path

fiftyone.utils.bdd.BDDDatasetExporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.bdd.BDDDatasetExporter.labels_path

fiftyone.utils.bdd.BDDDatasetExporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.bdd.BDDDatasetExporter.export_media

fiftyone.utils.bdd.BDDDatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.bdd.BDDDatasetExporter.rel_dir

fiftyone.utils.bdd.BDDDatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.bdd.BDDDatasetExporter.abs_paths

fiftyone.utils.bdd.BDDDatasetExporter.html#abs_paths

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.bdd.BDDDatasetExporter.image_format

fiftyone.utils.bdd.BDDDatasetExporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.bdd.BDDDatasetExporter.extra_attrs

fiftyone.utils.bdd.BDDDatasetExporter.html#extra_attrs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.bdd.BDDDatasetExporter.__init__

fiftyone.utils.bdd.BDDDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.bdd.BDDDatasetExporter._annotations

fiftyone.utils.bdd.BDDDatasetExporter.html#_annotations

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.bdd.BDDDatasetExporter._media_exporter

fiftyone.utils.bdd.BDDDatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.bdd.BDDDatasetExporter.requires_image_metadata

fiftyone.utils.bdd.BDDDatasetExporter.html#requires_image_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.
fiftyone.utils.bdd.BDDDatasetExporter.label_cls

fiftyone.utils.bdd.BDDDatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) exported by this exporter.
fiftyone.utils.bdd.BDDDatasetExporter.setup

fiftyone.utils.bdd.BDDDatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.bdd.BDDDatasetExporter.export_sample

fiftyone.utils.bdd.BDDDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.bdd.BDDDatasetExporter.close

fiftyone.utils.bdd.BDDDatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.bdd.load_bdd_annotations

fiftyone.utils.bdd.html#load_bdd_annotations

Function

Function

PUBLIC

Loads the BDD annotations from the given JSON file.
fiftyone.utils.bdd.parse_bdd100k_dataset

fiftyone.utils.bdd.html#parse_bdd100k_dataset

Function

Function

PUBLIC

Parses the raw BDD100K download files in the specified directory into per-split directories in BDD format.
fiftyone.utils.bdd._ensure_bdd100k_dir

fiftyone.utils.bdd.html#_ensure_bdd100k_dir

Function

Function

PRIVATE

Undocumented
fiftyone.utils.bdd._ensure_bdd100k_subdir

fiftyone.utils.bdd.html#_ensure_bdd100k_subdir

Function

Function

PRIVATE

Undocumented
fiftyone.utils.bdd._ensure_bdd100k_file

fiftyone.utils.bdd.html#_ensure_bdd100k_file

Function

Function

PRIVATE

Undocumented
fiftyone.utils.bdd._raise_bdd100k_error

fiftyone.utils.bdd.html#_raise_bdd100k_error

Function

Function

PRIVATE

Undocumented
fiftyone.utils.bdd._parse_bdd_annotation

fiftyone.utils.bdd.html#_parse_bdd_annotation

Function

Function

PRIVATE

Undocumented
fiftyone.utils.bdd._parse_frame_labels

fiftyone.utils.bdd.html#_parse_frame_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.bdd._parse_bdd_detection

fiftyone.utils.bdd.html#_parse_bdd_detection

Function

Function

PRIVATE

Undocumented
fiftyone.utils.bdd._parse_bdd_polylines

fiftyone.utils.bdd.html#_parse_bdd_polylines

Function

Function

PRIVATE

Undocumented
fiftyone.utils.bdd._filter_attributes

fiftyone.utils.bdd.html#_filter_attributes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.bdd._make_bdd_annotation

fiftyone.utils.bdd.html#_make_bdd_annotation

Function

Function

PRIVATE

Undocumented
fiftyone.utils.bdd._detection_to_bdd

fiftyone.utils.bdd.html#_detection_to_bdd

Function

Function

PRIVATE

Undocumented
fiftyone.utils.bdd._polyline_to_bdd

fiftyone.utils.bdd.html#_polyline_to_bdd

Function

Function

PRIVATE

Undocumented
fiftyone.utils.bdd._get_attributes

fiftyone.utils.bdd.html#_get_attributes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.beam.beam_import

fiftyone.utils.beam.html#beam_import

Function

Function

PUBLIC

Imports the given samples into the dataset via Apache Beam.
fiftyone.utils.beam.beam_merge

fiftyone.utils.beam.html#beam_merge

Function

Function

PUBLIC

Merges the given samples into the dataset via Apache Beam.
fiftyone.utils.beam.beam_export

fiftyone.utils.beam.html#beam_export

Function

Function

PUBLIC

Exports the given sample collection in the specified number shards via Apache Beam.
fiftyone.utils.beam.ImportBatch

fiftyone.utils.beam.ImportBatch.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.beam.ImportBatch.__init__

fiftyone.utils.beam.ImportBatch.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.beam.ImportBatch.dataset_name

fiftyone.utils.beam.ImportBatch.html#dataset_name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.beam.ImportBatch.parse_fcn

fiftyone.utils.beam.ImportBatch.html#parse_fcn

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.beam.ImportBatch.expand_schema

fiftyone.utils.beam.ImportBatch.html#expand_schema

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.beam.ImportBatch.dynamic

fiftyone.utils.beam.ImportBatch.html#dynamic

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.beam.ImportBatch.validate

fiftyone.utils.beam.ImportBatch.html#validate

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.beam.ImportBatch._dataset

fiftyone.utils.beam.ImportBatch.html#_dataset

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.beam.ImportBatch._samples

fiftyone.utils.beam.ImportBatch.html#_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.beam.ImportBatch.setup

fiftyone.utils.beam.ImportBatch.html#setup

Function

Method

PUBLIC

Undocumented
fiftyone.utils.beam.ImportBatch.start_bundle

fiftyone.utils.beam.ImportBatch.html#start_bundle

Function

Method

PUBLIC

Undocumented
fiftyone.utils.beam.ImportBatch.process

fiftyone.utils.beam.ImportBatch.html#process

Function

Method

PUBLIC

Undocumented
fiftyone.utils.beam.ImportBatch.finish_bundle

fiftyone.utils.beam.ImportBatch.html#finish_bundle

Function

Method

PUBLIC

Undocumented
fiftyone.utils.beam.MergeBatch

fiftyone.utils.beam.MergeBatch.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.beam.MergeBatch.__init__

fiftyone.utils.beam.MergeBatch.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.beam.MergeBatch.dataset_name

fiftyone.utils.beam.MergeBatch.html#dataset_name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.beam.MergeBatch.parse_fcn

fiftyone.utils.beam.MergeBatch.html#parse_fcn

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.beam.MergeBatch.key_field

fiftyone.utils.beam.MergeBatch.html#key_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.beam.MergeBatch.key_fcn

fiftyone.utils.beam.MergeBatch.html#key_fcn

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.beam.MergeBatch.expand_schema

fiftyone.utils.beam.MergeBatch.html#expand_schema

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.beam.MergeBatch.kwargs

fiftyone.utils.beam.MergeBatch.html#kwargs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.beam.MergeBatch._dataset

fiftyone.utils.beam.MergeBatch.html#_dataset

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.beam.MergeBatch._id_map

fiftyone.utils.beam.MergeBatch.html#_id_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.beam.MergeBatch._key_fcn

fiftyone.utils.beam.MergeBatch.html#_key_fcn

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.beam.MergeBatch._samples

fiftyone.utils.beam.MergeBatch.html#_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.beam.MergeBatch.setup

fiftyone.utils.beam.MergeBatch.html#setup

Function

Method

PUBLIC

Undocumented
fiftyone.utils.beam.MergeBatch.start_bundle

fiftyone.utils.beam.MergeBatch.html#start_bundle

Function

Method

PUBLIC

Undocumented
fiftyone.utils.beam.MergeBatch.process

fiftyone.utils.beam.MergeBatch.html#process

Function

Method

PUBLIC

Undocumented
fiftyone.utils.beam.MergeBatch.finish_bundle

fiftyone.utils.beam.MergeBatch.html#finish_bundle

Function

Method

PUBLIC

Undocumented
fiftyone.utils.beam.ExportBatch

fiftyone.utils.beam.ExportBatch.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.beam.ExportBatch.__init__

fiftyone.utils.beam.ExportBatch.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.beam.ExportBatch.dataset_name

fiftyone.utils.beam.ExportBatch.html#dataset_name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.beam.ExportBatch.view_stages

fiftyone.utils.beam.ExportBatch.html#view_stages

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.beam.ExportBatch.render_kwargs

fiftyone.utils.beam.ExportBatch.html#render_kwargs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.beam.ExportBatch._sample_collection

fiftyone.utils.beam.ExportBatch.html#_sample_collection

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.beam.ExportBatch.default_render_kwargs

fiftyone.utils.beam.ExportBatch.html#default_render_kwargs

Function

Static Method

PUBLIC

Undocumented
fiftyone.utils.beam.ExportBatch.setup

fiftyone.utils.beam.ExportBatch.html#setup

Function

Method

PUBLIC

Undocumented
fiftyone.utils.beam.ExportBatch.process

fiftyone.utils.beam.ExportBatch.html#process

Function

Method

PUBLIC

Undocumented
fiftyone.utils.beam._pop_first

fiftyone.utils.beam.html#_pop_first

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cityscapes.logger

fiftyone.utils.cityscapes.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.cityscapes._IMAGES_ZIP

fiftyone.utils.cityscapes.html#_IMAGES_ZIP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.cityscapes._FINE_ANNOS_ZIP

fiftyone.utils.cityscapes.html#_FINE_ANNOS_ZIP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.cityscapes._COARSE_ANNOS_ZIP

fiftyone.utils.cityscapes.html#_COARSE_ANNOS_ZIP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.cityscapes._PERSON_ANNOS_ZIP

fiftyone.utils.cityscapes.html#_PERSON_ANNOS_ZIP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.cityscapes.parse_cityscapes_dataset

fiftyone.utils.cityscapes.html#parse_cityscapes_dataset

Function

Function

PUBLIC

Parses the Cityscapes archive(s) in the specified directory and writes the requested splits in subdirectories of dataset_dir in fiftyone.types.FiftyOneDataset format.
fiftyone.utils.cityscapes._parse_source_dir

fiftyone.utils.cityscapes.html#_parse_source_dir

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cityscapes._raise_cityscapes_error

fiftyone.utils.cityscapes.html#_raise_cityscapes_error

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cityscapes._parse_split

fiftyone.utils.cityscapes.html#_parse_split

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cityscapes._export_split

fiftyone.utils.cityscapes.html#_export_split

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cityscapes._extract_images

fiftyone.utils.cityscapes.html#_extract_images

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cityscapes._extract_fine_annos

fiftyone.utils.cityscapes.html#_extract_fine_annos

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cityscapes._extract_coarse_annos

fiftyone.utils.cityscapes.html#_extract_coarse_annos

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cityscapes._extract_person_annos

fiftyone.utils.cityscapes.html#_extract_person_annos

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cityscapes._parse_images

fiftyone.utils.cityscapes.html#_parse_images

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cityscapes._parse_fine_annos

fiftyone.utils.cityscapes.html#_parse_fine_annos

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cityscapes._parse_coarse_annos

fiftyone.utils.cityscapes.html#_parse_coarse_annos

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cityscapes._parse_polygon_annos

fiftyone.utils.cityscapes.html#_parse_polygon_annos

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cityscapes._parse_person_annos

fiftyone.utils.cityscapes.html#_parse_person_annos

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cityscapes._parse_polygons_file

fiftyone.utils.cityscapes.html#_parse_polygons_file

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cityscapes._parse_bbox_file

fiftyone.utils.cityscapes.html#_parse_bbox_file

Function

Function

PRIVATE

Undocumented
fiftyone.utils.clip.tokenizer.default_bpe

fiftyone.utils.clip.tokenizer.html#default_bpe

Function

Function

PUBLIC

Undocumented
fiftyone.utils.clip.tokenizer.bytes_to_unicode

fiftyone.utils.clip.tokenizer.html#bytes_to_unicode

Function

Function

PUBLIC

Returns a list of utf-8 bytes and a corresponding list of unicode strings.
fiftyone.utils.clip.tokenizer.get_pairs

fiftyone.utils.clip.tokenizer.html#get_pairs

Function

Function

PUBLIC

Returns the set of symbol pairs in a word.
fiftyone.utils.clip.tokenizer.basic_clean

fiftyone.utils.clip.tokenizer.html#basic_clean

Function

Function

PUBLIC

Undocumented
fiftyone.utils.clip.tokenizer.whitespace_clean

fiftyone.utils.clip.tokenizer.html#whitespace_clean

Function

Function

PUBLIC

Undocumented
fiftyone.utils.clip.tokenizer.SimpleTokenizer

fiftyone.utils.clip.tokenizer.SimpleTokenizer.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.clip.tokenizer.SimpleTokenizer.__init__

fiftyone.utils.clip.tokenizer.SimpleTokenizer.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.tokenizer.SimpleTokenizer.byte_encoder

fiftyone.utils.clip.tokenizer.SimpleTokenizer.html#byte_encoder

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.tokenizer.SimpleTokenizer.byte_decoder

fiftyone.utils.clip.tokenizer.SimpleTokenizer.html#byte_decoder

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.tokenizer.SimpleTokenizer.encoder

fiftyone.utils.clip.tokenizer.SimpleTokenizer.html#encoder

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.tokenizer.SimpleTokenizer.decoder

fiftyone.utils.clip.tokenizer.SimpleTokenizer.html#decoder

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.tokenizer.SimpleTokenizer.bpe_ranks

fiftyone.utils.clip.tokenizer.SimpleTokenizer.html#bpe_ranks

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.tokenizer.SimpleTokenizer.cache

fiftyone.utils.clip.tokenizer.SimpleTokenizer.html#cache

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.tokenizer.SimpleTokenizer.pat

fiftyone.utils.clip.tokenizer.SimpleTokenizer.html#pat

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.tokenizer.SimpleTokenizer.bpe

fiftyone.utils.clip.tokenizer.SimpleTokenizer.html#bpe

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.tokenizer.SimpleTokenizer.encode

fiftyone.utils.clip.tokenizer.SimpleTokenizer.html#encode

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.tokenizer.SimpleTokenizer.decode

fiftyone.utils.clip.tokenizer.SimpleTokenizer.html#decode

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.Bottleneck

fiftyone.utils.clip.model.Bottleneck.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.clip.model.Bottleneck.expansion

fiftyone.utils.clip.model.Bottleneck.html#expansion

Attribute

Class Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.Bottleneck.__init__

fiftyone.utils.clip.model.Bottleneck.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.Bottleneck.conv1

fiftyone.utils.clip.model.Bottleneck.html#conv1

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.Bottleneck.bn1

fiftyone.utils.clip.model.Bottleneck.html#bn1

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.Bottleneck.conv2

fiftyone.utils.clip.model.Bottleneck.html#conv2

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.Bottleneck.bn2

fiftyone.utils.clip.model.Bottleneck.html#bn2

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.Bottleneck.avgpool

fiftyone.utils.clip.model.Bottleneck.html#avgpool

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.Bottleneck.conv3

fiftyone.utils.clip.model.Bottleneck.html#conv3

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.Bottleneck.bn3

fiftyone.utils.clip.model.Bottleneck.html#bn3

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.Bottleneck.relu

fiftyone.utils.clip.model.Bottleneck.html#relu

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.Bottleneck.downsample

fiftyone.utils.clip.model.Bottleneck.html#downsample

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.Bottleneck.stride

fiftyone.utils.clip.model.Bottleneck.html#stride

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.Bottleneck.forward

fiftyone.utils.clip.model.Bottleneck.html#forward

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.AttentionPool2d

fiftyone.utils.clip.model.AttentionPool2d.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.clip.model.AttentionPool2d.__init__

fiftyone.utils.clip.model.AttentionPool2d.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.AttentionPool2d.positional_embedding

fiftyone.utils.clip.model.AttentionPool2d.html#positional_embedding

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.AttentionPool2d.k_proj

fiftyone.utils.clip.model.AttentionPool2d.html#k_proj

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.AttentionPool2d.q_proj

fiftyone.utils.clip.model.AttentionPool2d.html#q_proj

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.AttentionPool2d.v_proj

fiftyone.utils.clip.model.AttentionPool2d.html#v_proj

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.AttentionPool2d.c_proj

fiftyone.utils.clip.model.AttentionPool2d.html#c_proj

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.AttentionPool2d.num_heads

fiftyone.utils.clip.model.AttentionPool2d.html#num_heads

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.AttentionPool2d.forward

fiftyone.utils.clip.model.AttentionPool2d.html#forward

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet

fiftyone.utils.clip.model.ModifiedResNet.html

Class

Class

PUBLIC

A ResNet class that is similar to torchvision's but contains the following changes:
fiftyone.utils.clip.model.ModifiedResNet.__init__

fiftyone.utils.clip.model.ModifiedResNet.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet.output_dim

fiftyone.utils.clip.model.ModifiedResNet.html#output_dim

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet.input_resolution

fiftyone.utils.clip.model.ModifiedResNet.html#input_resolution

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet.conv1

fiftyone.utils.clip.model.ModifiedResNet.html#conv1

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet.bn1

fiftyone.utils.clip.model.ModifiedResNet.html#bn1

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet.conv2

fiftyone.utils.clip.model.ModifiedResNet.html#conv2

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet.bn2

fiftyone.utils.clip.model.ModifiedResNet.html#bn2

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet.conv3

fiftyone.utils.clip.model.ModifiedResNet.html#conv3

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet.bn3

fiftyone.utils.clip.model.ModifiedResNet.html#bn3

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet.avgpool

fiftyone.utils.clip.model.ModifiedResNet.html#avgpool

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet.relu

fiftyone.utils.clip.model.ModifiedResNet.html#relu

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet._inplanes

fiftyone.utils.clip.model.ModifiedResNet.html#_inplanes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.clip.model.ModifiedResNet.layer1

fiftyone.utils.clip.model.ModifiedResNet.html#layer1

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet.layer2

fiftyone.utils.clip.model.ModifiedResNet.html#layer2

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet.layer3

fiftyone.utils.clip.model.ModifiedResNet.html#layer3

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet.layer4

fiftyone.utils.clip.model.ModifiedResNet.html#layer4

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet.attnpool

fiftyone.utils.clip.model.ModifiedResNet.html#attnpool

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ModifiedResNet._make_layer

fiftyone.utils.clip.model.ModifiedResNet.html#_make_layer

Function

Method

PRIVATE

Undocumented
fiftyone.utils.clip.model.ModifiedResNet.forward

fiftyone.utils.clip.model.ModifiedResNet.html#forward

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.LayerNorm

fiftyone.utils.clip.model.LayerNorm.html

Class

Class

PUBLIC

Subclass torch's LayerNorm to handle fp16.
fiftyone.utils.clip.model.LayerNorm.forward

fiftyone.utils.clip.model.LayerNorm.html#forward

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.QuickGELU

fiftyone.utils.clip.model.QuickGELU.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.clip.model.QuickGELU.forward

fiftyone.utils.clip.model.QuickGELU.html#forward

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.ResidualAttentionBlock

fiftyone.utils.clip.model.ResidualAttentionBlock.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.clip.model.ResidualAttentionBlock.__init__

fiftyone.utils.clip.model.ResidualAttentionBlock.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.ResidualAttentionBlock.attn

fiftyone.utils.clip.model.ResidualAttentionBlock.html#attn

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ResidualAttentionBlock.ln_1

fiftyone.utils.clip.model.ResidualAttentionBlock.html#ln_1

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ResidualAttentionBlock.mlp

fiftyone.utils.clip.model.ResidualAttentionBlock.html#mlp

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ResidualAttentionBlock.ln_2

fiftyone.utils.clip.model.ResidualAttentionBlock.html#ln_2

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ResidualAttentionBlock.attn_mask

fiftyone.utils.clip.model.ResidualAttentionBlock.html#attn_mask

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.ResidualAttentionBlock.attention

fiftyone.utils.clip.model.ResidualAttentionBlock.html#attention

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.ResidualAttentionBlock.forward

fiftyone.utils.clip.model.ResidualAttentionBlock.html#forward

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.Transformer

fiftyone.utils.clip.model.Transformer.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.clip.model.Transformer.__init__

fiftyone.utils.clip.model.Transformer.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.Transformer.width

fiftyone.utils.clip.model.Transformer.html#width

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.Transformer.layers

fiftyone.utils.clip.model.Transformer.html#layers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.Transformer.resblocks

fiftyone.utils.clip.model.Transformer.html#resblocks

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.Transformer.forward

fiftyone.utils.clip.model.Transformer.html#forward

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.VisionTransformer

fiftyone.utils.clip.model.VisionTransformer.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.clip.model.VisionTransformer.__init__

fiftyone.utils.clip.model.VisionTransformer.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.VisionTransformer.input_resolution

fiftyone.utils.clip.model.VisionTransformer.html#input_resolution

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.VisionTransformer.output_dim

fiftyone.utils.clip.model.VisionTransformer.html#output_dim

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.VisionTransformer.conv1

fiftyone.utils.clip.model.VisionTransformer.html#conv1

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.VisionTransformer.class_embedding

fiftyone.utils.clip.model.VisionTransformer.html#class_embedding

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.VisionTransformer.positional_embedding

fiftyone.utils.clip.model.VisionTransformer.html#positional_embedding

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.VisionTransformer.ln_pre

fiftyone.utils.clip.model.VisionTransformer.html#ln_pre

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.VisionTransformer.transformer

fiftyone.utils.clip.model.VisionTransformer.html#transformer

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.VisionTransformer.ln_post

fiftyone.utils.clip.model.VisionTransformer.html#ln_post

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.VisionTransformer.proj

fiftyone.utils.clip.model.VisionTransformer.html#proj

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.VisionTransformer.forward

fiftyone.utils.clip.model.VisionTransformer.html#forward

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP

fiftyone.utils.clip.model.CLIP.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP.__init__

fiftyone.utils.clip.model.CLIP.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP.context_length

fiftyone.utils.clip.model.CLIP.html#context_length

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP.visual

fiftyone.utils.clip.model.CLIP.html#visual

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP.transformer

fiftyone.utils.clip.model.CLIP.html#transformer

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP.vocab_size

fiftyone.utils.clip.model.CLIP.html#vocab_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP.token_embedding

fiftyone.utils.clip.model.CLIP.html#token_embedding

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP.positional_embedding

fiftyone.utils.clip.model.CLIP.html#positional_embedding

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP.ln_final

fiftyone.utils.clip.model.CLIP.html#ln_final

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP.text_projection

fiftyone.utils.clip.model.CLIP.html#text_projection

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP.logit_scale

fiftyone.utils.clip.model.CLIP.html#logit_scale

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP.initialize_parameters

fiftyone.utils.clip.model.CLIP.html#initialize_parameters

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP.build_attention_mask

fiftyone.utils.clip.model.CLIP.html#build_attention_mask

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP.dtype

fiftyone.utils.clip.model.CLIP.html#dtype

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP.encode_image

fiftyone.utils.clip.model.CLIP.html#encode_image

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP.encode_text

fiftyone.utils.clip.model.CLIP.html#encode_text

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.CLIP.forward

fiftyone.utils.clip.model.CLIP.html#forward

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.model.convert_weights

fiftyone.utils.clip.model.html#convert_weights

Function

Function

PUBLIC

Converts applicable model parameters to fp16.
fiftyone.utils.clip.model.build_model

fiftyone.utils.clip.model.html#build_model

Function

Function

PUBLIC

Undocumented
fiftyone.utils.clip.zoo.logger

fiftyone.utils.clip.zoo.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModelConfig

fiftyone.utils.clip.zoo.TorchCLIPModelConfig.html

Class

Class

PUBLIC

Configuration for running a TorchCLIPModel.
fiftyone.utils.clip.zoo.TorchCLIPModelConfig.__init__

fiftyone.utils.clip.zoo.TorchCLIPModelConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModelConfig.tokenizer_base_filename

fiftyone.utils.clip.zoo.TorchCLIPModelConfig.html#tokenizer_base_filename

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModelConfig.tokenizer_base_url

fiftyone.utils.clip.zoo.TorchCLIPModelConfig.html#tokenizer_base_url

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModelConfig.context_length

fiftyone.utils.clip.zoo.TorchCLIPModelConfig.html#context_length

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModelConfig.text_prompt

fiftyone.utils.clip.zoo.TorchCLIPModelConfig.html#text_prompt

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModelConfig._tokenizer_path

fiftyone.utils.clip.zoo.TorchCLIPModelConfig.html#_tokenizer_path

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModelConfig.tokenizer_path

fiftyone.utils.clip.zoo.TorchCLIPModelConfig.html#tokenizer_path

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModelConfig.download_tokenizer_if_necessary

fiftyone.utils.clip.zoo.TorchCLIPModelConfig.html#download_tokenizer_if_necessary

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModel

fiftyone.utils.clip.zoo.TorchCLIPModel.html

Class

Class

PUBLIC

Torch implementation of CLIP from https://github.com/openai/CLIP.
fiftyone.utils.clip.zoo.TorchCLIPModel.__init__

fiftyone.utils.clip.zoo.TorchCLIPModel.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModel._tokenizer

fiftyone.utils.clip.zoo.TorchCLIPModel.html#_tokenizer

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModel._text_features

fiftyone.utils.clip.zoo.TorchCLIPModel.html#_text_features

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModel.can_embed_prompts

fiftyone.utils.clip.zoo.TorchCLIPModel.html#can_embed_prompts

Attribute

Property

PUBLIC

Whether this instance can generate prompt embeddings.
fiftyone.utils.clip.zoo.TorchCLIPModel.embed_prompt

fiftyone.utils.clip.zoo.TorchCLIPModel.html#embed_prompt

Function

Method

PUBLIC

Generates an embedding for the given text prompt.
fiftyone.utils.clip.zoo.TorchCLIPModel.embed_prompts

fiftyone.utils.clip.zoo.TorchCLIPModel.html#embed_prompts

Function

Method

PUBLIC

Generates an embedding for the given text prompts.
fiftyone.utils.clip.zoo.TorchCLIPModel._download_model

fiftyone.utils.clip.zoo.TorchCLIPModel.html#_download_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModel._load_model

fiftyone.utils.clip.zoo.TorchCLIPModel.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModel._embed_prompts

fiftyone.utils.clip.zoo.TorchCLIPModel.html#_embed_prompts

Function

Method

PRIVATE

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModel._get_text_features

fiftyone.utils.clip.zoo.TorchCLIPModel.html#_get_text_features

Function

Method

PRIVATE

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModel._get_class_logits

fiftyone.utils.clip.zoo.TorchCLIPModel.html#_get_class_logits

Function

Method

PRIVATE

Undocumented
fiftyone.utils.clip.zoo.TorchCLIPModel._predict_all

fiftyone.utils.clip.zoo.TorchCLIPModel.html#_predict_all

Function

Method

PRIVATE

Applies a forward pass to the given iterable of data and returns the raw model output with no processing applied.
fiftyone.utils.coco.mask_utils

fiftyone.utils.coco.html#mask_utils

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.coco.logger

fiftyone.utils.coco.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.coco.add_coco_labels

fiftyone.utils.coco.html#add_coco_labels

Function

Function

PUBLIC

Adds the given COCO labels to the collection.
fiftyone.utils.coco.COCODetectionDatasetImporter

fiftyone.utils.coco.COCODetectionDatasetImporter.html

Class

Class

PUBLIC

Importer for COCO detection datasets stored on disk.
fiftyone.utils.coco.COCODetectionDatasetImporter.data_path

fiftyone.utils.coco.COCODetectionDatasetImporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter.labels_path

fiftyone.utils.coco.COCODetectionDatasetImporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter.label_types

fiftyone.utils.coco.COCODetectionDatasetImporter.html#label_types

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter.classes

fiftyone.utils.coco.COCODetectionDatasetImporter.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter.image_ids

fiftyone.utils.coco.COCODetectionDatasetImporter.html#image_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter.include_id

fiftyone.utils.coco.COCODetectionDatasetImporter.html#include_id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter.include_annotation_id

fiftyone.utils.coco.COCODetectionDatasetImporter.html#include_annotation_id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter.include_license

fiftyone.utils.coco.COCODetectionDatasetImporter.html#include_license

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter.extra_attrs

fiftyone.utils.coco.COCODetectionDatasetImporter.html#extra_attrs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter.only_matching

fiftyone.utils.coco.COCODetectionDatasetImporter.html#only_matching

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter.use_polylines

fiftyone.utils.coco.COCODetectionDatasetImporter.html#use_polylines

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter.tolerance

fiftyone.utils.coco.COCODetectionDatasetImporter.html#tolerance

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter.__init__

fiftyone.utils.coco.COCODetectionDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter._label_types

fiftyone.utils.coco.COCODetectionDatasetImporter.html#_label_types

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter._info

fiftyone.utils.coco.COCODetectionDatasetImporter.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter._classes_map

fiftyone.utils.coco.COCODetectionDatasetImporter.html#_classes_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter._class_ids

fiftyone.utils.coco.COCODetectionDatasetImporter.html#_class_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter._license_map

fiftyone.utils.coco.COCODetectionDatasetImporter.html#_license_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter._supercategory_map

fiftyone.utils.coco.COCODetectionDatasetImporter.html#_supercategory_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter._image_paths_map

fiftyone.utils.coco.COCODetectionDatasetImporter.html#_image_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter._image_dicts_map

fiftyone.utils.coco.COCODetectionDatasetImporter.html#_image_dicts_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter._annotations

fiftyone.utils.coco.COCODetectionDatasetImporter.html#_annotations

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter._filenames

fiftyone.utils.coco.COCODetectionDatasetImporter.html#_filenames

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter._iter_filenames

fiftyone.utils.coco.COCODetectionDatasetImporter.html#_iter_filenames

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter.__iter__

fiftyone.utils.coco.COCODetectionDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter.__len__

fiftyone.utils.coco.COCODetectionDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.coco.COCODetectionDatasetImporter.__next__

fiftyone.utils.coco.COCODetectionDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.coco.COCODetectionDatasetImporter.has_dataset_info

fiftyone.utils.coco.COCODetectionDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.coco.COCODetectionDatasetImporter.has_image_metadata

fiftyone.utils.coco.COCODetectionDatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.coco.COCODetectionDatasetImporter._has_scalar_labels

fiftyone.utils.coco.COCODetectionDatasetImporter.html#_has_scalar_labels

Attribute

Property

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetImporter.label_cls

fiftyone.utils.coco.COCODetectionDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.coco.COCODetectionDatasetImporter.setup

fiftyone.utils.coco.COCODetectionDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.coco.COCODetectionDatasetImporter.get_dataset_info

fiftyone.utils.coco.COCODetectionDatasetImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.coco.COCODetectionDatasetExporter

fiftyone.utils.coco.COCODetectionDatasetExporter.html

Class

Class

PUBLIC

Exporter that writes COCO detection datasets to disk.
fiftyone.utils.coco.COCODetectionDatasetExporter.data_path

fiftyone.utils.coco.COCODetectionDatasetExporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter.labels_path

fiftyone.utils.coco.COCODetectionDatasetExporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter.export_media

fiftyone.utils.coco.COCODetectionDatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter.rel_dir

fiftyone.utils.coco.COCODetectionDatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter.abs_paths

fiftyone.utils.coco.COCODetectionDatasetExporter.html#abs_paths

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter.image_format

fiftyone.utils.coco.COCODetectionDatasetExporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter.classes

fiftyone.utils.coco.COCODetectionDatasetExporter.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter.categories

fiftyone.utils.coco.COCODetectionDatasetExporter.html#categories

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter.info

fiftyone.utils.coco.COCODetectionDatasetExporter.html#info

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter.extra_attrs

fiftyone.utils.coco.COCODetectionDatasetExporter.html#extra_attrs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter.coco_id

fiftyone.utils.coco.COCODetectionDatasetExporter.html#coco_id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter.annotation_id

fiftyone.utils.coco.COCODetectionDatasetExporter.html#annotation_id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter.iscrowd

fiftyone.utils.coco.COCODetectionDatasetExporter.html#iscrowd

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter.num_decimals

fiftyone.utils.coco.COCODetectionDatasetExporter.html#num_decimals

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter.tolerance

fiftyone.utils.coco.COCODetectionDatasetExporter.html#tolerance

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter.__init__

fiftyone.utils.coco.COCODetectionDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter._image_id

fiftyone.utils.coco.COCODetectionDatasetExporter.html#_image_id

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter._image_id_map

fiftyone.utils.coco.COCODetectionDatasetExporter.html#_image_id_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter._anno_id

fiftyone.utils.coco.COCODetectionDatasetExporter.html#_anno_id

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter._images

fiftyone.utils.coco.COCODetectionDatasetExporter.html#_images

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter._annotations

fiftyone.utils.coco.COCODetectionDatasetExporter.html#_annotations

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter._classes

fiftyone.utils.coco.COCODetectionDatasetExporter.html#_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter._dynamic_classes

fiftyone.utils.coco.COCODetectionDatasetExporter.html#_dynamic_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter._labels_map_rev

fiftyone.utils.coco.COCODetectionDatasetExporter.html#_labels_map_rev

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter._has_labels

fiftyone.utils.coco.COCODetectionDatasetExporter.html#_has_labels

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter._media_exporter

fiftyone.utils.coco.COCODetectionDatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.coco.COCODetectionDatasetExporter.requires_image_metadata

fiftyone.utils.coco.COCODetectionDatasetExporter.html#requires_image_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.
fiftyone.utils.coco.COCODetectionDatasetExporter.label_cls

fiftyone.utils.coco.COCODetectionDatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) exported by this exporter.
fiftyone.utils.coco.COCODetectionDatasetExporter.setup

fiftyone.utils.coco.COCODetectionDatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.coco.COCODetectionDatasetExporter.log_collection

fiftyone.utils.coco.COCODetectionDatasetExporter.html#log_collection

Function

Method

PUBLIC

Logs any relevant information about the fiftyone.core.collections.SampleCollection whose samples will be exported.
fiftyone.utils.coco.COCODetectionDatasetExporter.export_sample

fiftyone.utils.coco.COCODetectionDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.coco.COCODetectionDatasetExporter.close

fiftyone.utils.coco.COCODetectionDatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.coco.COCODetectionDatasetExporter._parse_classes

fiftyone.utils.coco.COCODetectionDatasetExporter.html#_parse_classes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.coco.COCOObject

fiftyone.utils.coco.COCOObject.html

Class

Class

PUBLIC

An object in COCO format.
fiftyone.utils.coco.COCOObject.id

fiftyone.utils.coco.COCOObject.html#id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCOObject.image_id

fiftyone.utils.coco.COCOObject.html#image_id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCOObject.category_id

fiftyone.utils.coco.COCOObject.html#category_id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCOObject.bbox

fiftyone.utils.coco.COCOObject.html#bbox

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCOObject.segmentation

fiftyone.utils.coco.COCOObject.html#segmentation

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCOObject.keypoints

fiftyone.utils.coco.COCOObject.html#keypoints

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCOObject.score

fiftyone.utils.coco.COCOObject.html#score

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCOObject.area

fiftyone.utils.coco.COCOObject.html#area

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCOObject.iscrowd

fiftyone.utils.coco.COCOObject.html#iscrowd

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCOObject.__init__

fiftyone.utils.coco.COCOObject.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.coco.COCOObject.attributes

fiftyone.utils.coco.COCOObject.html#attributes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.coco.COCOObject.to_polyline

fiftyone.utils.coco.COCOObject.html#to_polyline

Function

Method

PUBLIC

Returns a fiftyone.core.labels.Polyline representation of the object.
fiftyone.utils.coco.COCOObject.to_keypoints

fiftyone.utils.coco.COCOObject.html#to_keypoints

Function

Method

PUBLIC

Returns a fiftyone.core.labels.Keypoint representation of the object.
fiftyone.utils.coco.COCOObject.to_detection

fiftyone.utils.coco.COCOObject.html#to_detection

Function

Method

PUBLIC

Returns a fiftyone.core.labels.Detection representation of the object.
fiftyone.utils.coco.COCOObject.to_anno_dict

fiftyone.utils.coco.COCOObject.html#to_anno_dict

Function

Method

PUBLIC

Returns a COCO annotation dictionary representation of the object.
fiftyone.utils.coco.COCOObject.from_anno_dict

fiftyone.utils.coco.COCOObject.html#from_anno_dict

Function

Class Method

PUBLIC

Creates a COCOObject from a COCO annotation dict.
fiftyone.utils.coco.COCOObject.from_label

fiftyone.utils.coco.COCOObject.html#from_label

Function

Class Method

PUBLIC

Creates a COCOObject from a compatible fiftyone.core.labels.Label.
fiftyone.utils.coco.COCOObject._get_label

fiftyone.utils.coco.COCOObject.html#_get_label

Function

Method

PRIVATE

Undocumented
fiftyone.utils.coco.COCOObject._get_object_label_and_attributes

fiftyone.utils.coco.COCOObject.html#_get_object_label_and_attributes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.coco.load_coco_detection_annotations

fiftyone.utils.coco.html#load_coco_detection_annotations

Function

Function

PUBLIC

Loads the COCO annotations from the given JSON file.
fiftyone.utils.coco._parse_coco_detection_annotations

fiftyone.utils.coco.html#_parse_coco_detection_annotations

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco.parse_coco_categories

fiftyone.utils.coco.html#parse_coco_categories

Function

Function

PUBLIC

Parses the COCO categories list.
fiftyone.utils.coco.download_coco_dataset_split

fiftyone.utils.coco.html#download_coco_dataset_split

Function

Function

PUBLIC

Utility that downloads full or partial splits of the COCO dataset.
fiftyone.utils.coco._merge_dir

fiftyone.utils.coco.html#_merge_dir

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._write_partial_annotations

fiftyone.utils.coco.html#_write_partial_annotations

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._parse_label_types

fiftyone.utils.coco.html#_parse_label_types

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._parse_include_license

fiftyone.utils.coco.html#_parse_include_license

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._get_matching_image_ids

fiftyone.utils.coco.html#_get_matching_image_ids

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._get_existing_ids

fiftyone.utils.coco.html#_get_existing_ids

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._download_images

fiftyone.utils.coco.html#_download_images

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._do_download

fiftyone.utils.coco.html#_do_download

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._get_images_with_classes

fiftyone.utils.coco.html#_get_images_with_classes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._parse_image_ids

fiftyone.utils.coco.html#_parse_image_ids

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._load_image_ids_txt

fiftyone.utils.coco.html#_load_image_ids_txt

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._load_image_ids_csv

fiftyone.utils.coco.html#_load_image_ids_csv

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._load_image_ids_json

fiftyone.utils.coco.html#_load_image_ids_json

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._to_labels_map_rev

fiftyone.utils.coco.html#_to_labels_map_rev

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._to_classes

fiftyone.utils.coco.html#_to_classes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._get_class_ids

fiftyone.utils.coco.html#_get_class_ids

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._get_matching_objects

fiftyone.utils.coco.html#_get_matching_objects

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._parse_categories

fiftyone.utils.coco.html#_parse_categories

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._coco_objects_to_polylines

fiftyone.utils.coco.html#_coco_objects_to_polylines

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._coco_objects_to_detections

fiftyone.utils.coco.html#_coco_objects_to_detections

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._coco_objects_to_keypoints

fiftyone.utils.coco.html#_coco_objects_to_keypoints

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._get_attributes

fiftyone.utils.coco.html#_get_attributes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._get_polygons_for_segmentation

fiftyone.utils.coco.html#_get_polygons_for_segmentation

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._pairwise

fiftyone.utils.coco.html#_pairwise

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._coco_segmentation_to_mask

fiftyone.utils.coco.html#_coco_segmentation_to_mask

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._normalize_coco_segmentation

fiftyone.utils.coco.html#_normalize_coco_segmentation

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._polyline_to_coco_segmentation

fiftyone.utils.coco.html#_polyline_to_coco_segmentation

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._instance_to_coco_segmentation

fiftyone.utils.coco.html#_instance_to_coco_segmentation

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._make_coco_keypoints

fiftyone.utils.coco.html#_make_coco_keypoints

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._mask_to_rle

fiftyone.utils.coco.html#_mask_to_rle

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._mask_to_polygons

fiftyone.utils.coco.html#_mask_to_polygons

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._close_contour

fiftyone.utils.coco.html#_close_contour

Function

Function

PRIVATE

Undocumented
fiftyone.utils.coco._IMAGE_DOWNLOAD_LINKS

fiftyone.utils.coco.html#_IMAGE_DOWNLOAD_LINKS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.coco._SPLIT_SIZES

fiftyone.utils.coco.html#_SPLIT_SIZES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.coco._ANNOTATION_DOWNLOAD_LINKS

fiftyone.utils.coco.html#_ANNOTATION_DOWNLOAD_LINKS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.coco._ANNOTATION_PATHS

fiftyone.utils.coco.html#_ANNOTATION_PATHS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.coco._KEYPOINTS_PATHS

fiftyone.utils.coco.html#_KEYPOINTS_PATHS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.coco._TEST_INFO_DOWNLOAD_LINKS

fiftyone.utils.coco.html#_TEST_INFO_DOWNLOAD_LINKS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.coco._TEST_INFO_PATHS

fiftyone.utils.coco.html#_TEST_INFO_PATHS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.coco._SUPPORTED_LABEL_TYPES

fiftyone.utils.coco.html#_SUPPORTED_LABEL_TYPES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.coco._SUPPORTED_SPLITS

fiftyone.utils.coco.html#_SUPPORTED_SPLITS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.coco._CSV_DELIMITERS

fiftyone.utils.coco.html#_CSV_DELIMITERS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.csv.CSVDatasetImporter

fiftyone.utils.csv.CSVDatasetImporter.html

Class

Class

PUBLIC

A flexible CSV importer that represents slice(s) of field values of a dataset as columns of a CSV file.
fiftyone.utils.csv.CSVDatasetImporter.data_path

fiftyone.utils.csv.CSVDatasetImporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.csv.CSVDatasetImporter.labels_path

fiftyone.utils.csv.CSVDatasetImporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.csv.CSVDatasetImporter.media_field

fiftyone.utils.csv.CSVDatasetImporter.html#media_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.csv.CSVDatasetImporter.fields

fiftyone.utils.csv.CSVDatasetImporter.html#fields

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.csv.CSVDatasetImporter.skip_missing_media

fiftyone.utils.csv.CSVDatasetImporter.html#skip_missing_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.csv.CSVDatasetImporter.include_all_data

fiftyone.utils.csv.CSVDatasetImporter.html#include_all_data

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.csv.CSVDatasetImporter.__init__

fiftyone.utils.csv.CSVDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.csv.CSVDatasetImporter._media_paths_map

fiftyone.utils.csv.CSVDatasetImporter.html#_media_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.csv.CSVDatasetImporter._rows_map

fiftyone.utils.csv.CSVDatasetImporter.html#_rows_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.csv.CSVDatasetImporter._fields

fiftyone.utils.csv.CSVDatasetImporter.html#_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.csv.CSVDatasetImporter._filepaths

fiftyone.utils.csv.CSVDatasetImporter.html#_filepaths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.csv.CSVDatasetImporter._iter_filepaths

fiftyone.utils.csv.CSVDatasetImporter.html#_iter_filepaths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.csv.CSVDatasetImporter._num_samples

fiftyone.utils.csv.CSVDatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.csv.CSVDatasetImporter.__iter__

fiftyone.utils.csv.CSVDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.csv.CSVDatasetImporter.__len__

fiftyone.utils.csv.CSVDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.csv.CSVDatasetImporter.__next__

fiftyone.utils.csv.CSVDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.csv.CSVDatasetImporter.has_sample_field_schema

fiftyone.utils.csv.CSVDatasetImporter.html#has_sample_field_schema

Attribute

Property

PUBLIC

Whether this importer produces a sample field schema.
fiftyone.utils.csv.CSVDatasetImporter.has_dataset_info

fiftyone.utils.csv.CSVDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.csv.CSVDatasetImporter.setup

fiftyone.utils.csv.CSVDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.csv._parse_import_fields

fiftyone.utils.csv.html#_parse_import_fields

Function

Function

PRIVATE

Undocumented
fiftyone.utils.csv.CSVDatasetExporter

fiftyone.utils.csv.CSVDatasetExporter.html

Class

Class

PUBLIC

A flexible CSV exporter that represents slice(s) of field values of a dataset as columns of a CSV file.
fiftyone.utils.csv.CSVDatasetExporter.data_path

fiftyone.utils.csv.CSVDatasetExporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.csv.CSVDatasetExporter.labels_path

fiftyone.utils.csv.CSVDatasetExporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.csv.CSVDatasetExporter.export_media

fiftyone.utils.csv.CSVDatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.csv.CSVDatasetExporter.rel_dir

fiftyone.utils.csv.CSVDatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.csv.CSVDatasetExporter.abs_paths

fiftyone.utils.csv.CSVDatasetExporter.html#abs_paths

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.csv.CSVDatasetExporter.media_field

fiftyone.utils.csv.CSVDatasetExporter.html#media_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.csv.CSVDatasetExporter.fields

fiftyone.utils.csv.CSVDatasetExporter.html#fields

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.csv.CSVDatasetExporter.__init__

fiftyone.utils.csv.CSVDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.csv.CSVDatasetExporter._media_exporter

fiftyone.utils.csv.CSVDatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.csv.CSVDatasetExporter._f

fiftyone.utils.csv.CSVDatasetExporter.html#_f

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.csv.CSVDatasetExporter._csv_writer

fiftyone.utils.csv.CSVDatasetExporter.html#_csv_writer

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.csv.CSVDatasetExporter._paths

fiftyone.utils.csv.CSVDatasetExporter.html#_paths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.csv.CSVDatasetExporter._media_idx

fiftyone.utils.csv.CSVDatasetExporter.html#_media_idx

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.csv.CSVDatasetExporter._include_media

fiftyone.utils.csv.CSVDatasetExporter.html#_include_media

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.csv.CSVDatasetExporter._needs_metadata

fiftyone.utils.csv.CSVDatasetExporter.html#_needs_metadata

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.csv.CSVDatasetExporter.setup

fiftyone.utils.csv.CSVDatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.csv.CSVDatasetExporter.export_samples

fiftyone.utils.csv.CSVDatasetExporter.html#export_samples

Function

Method

PUBLIC

Exports the given sample collection.
fiftyone.utils.csv.CSVDatasetExporter.close

fiftyone.utils.csv.CSVDatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.csv._parse_export_fields

fiftyone.utils.csv.html#_parse_export_fields

Function

Function

PRIVATE

Undocumented
fiftyone.utils.csv._parse_value

fiftyone.utils.csv.html#_parse_value

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat.logger

fiftyone.utils.cvat.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.import_annotations

fiftyone.utils.cvat.html#import_annotations

Function

Function

PUBLIC

Imports annotations from the specified CVAT project or task(s) into the given sample collection.
fiftyone.utils.cvat._parse_task_metadata

fiftyone.utils.cvat.html#_parse_task_metadata

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._download_media

fiftyone.utils.cvat.html#_download_media

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._do_download_media

fiftyone.utils.cvat.html#_do_download_media

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._download_annotations

fiftyone.utils.cvat.html#_download_annotations

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._build_sparse_frame_id_map

fiftyone.utils.cvat.html#_build_sparse_frame_id_map

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATImageDatasetImporter

fiftyone.utils.cvat.CVATImageDatasetImporter.html

Class

Class

PUBLIC

Importer for CVAT image datasets stored on disk.
fiftyone.utils.cvat.CVATImageDatasetImporter.data_path

fiftyone.utils.cvat.CVATImageDatasetImporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageDatasetImporter.labels_path

fiftyone.utils.cvat.CVATImageDatasetImporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageDatasetImporter.include_all_data

fiftyone.utils.cvat.CVATImageDatasetImporter.html#include_all_data

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageDatasetImporter.__init__

fiftyone.utils.cvat.CVATImageDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageDatasetImporter._info

fiftyone.utils.cvat.CVATImageDatasetImporter.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATImageDatasetImporter._image_paths_map

fiftyone.utils.cvat.CVATImageDatasetImporter.html#_image_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATImageDatasetImporter._cvat_images_map

fiftyone.utils.cvat.CVATImageDatasetImporter.html#_cvat_images_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATImageDatasetImporter._filenames

fiftyone.utils.cvat.CVATImageDatasetImporter.html#_filenames

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATImageDatasetImporter._iter_filenames

fiftyone.utils.cvat.CVATImageDatasetImporter.html#_iter_filenames

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATImageDatasetImporter._num_samples

fiftyone.utils.cvat.CVATImageDatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATImageDatasetImporter.__iter__

fiftyone.utils.cvat.CVATImageDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageDatasetImporter.__len__

fiftyone.utils.cvat.CVATImageDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.cvat.CVATImageDatasetImporter.__next__

fiftyone.utils.cvat.CVATImageDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.cvat.CVATImageDatasetImporter.has_dataset_info

fiftyone.utils.cvat.CVATImageDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.cvat.CVATImageDatasetImporter.has_image_metadata

fiftyone.utils.cvat.CVATImageDatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.cvat.CVATImageDatasetImporter.label_cls

fiftyone.utils.cvat.CVATImageDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.cvat.CVATImageDatasetImporter.setup

fiftyone.utils.cvat.CVATImageDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.cvat.CVATImageDatasetImporter.get_dataset_info

fiftyone.utils.cvat.CVATImageDatasetImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.cvat.CVATVideoDatasetImporter

fiftyone.utils.cvat.CVATVideoDatasetImporter.html

Class

Class

PUBLIC

Importer for CVAT video datasets stored on disk.
fiftyone.utils.cvat.CVATVideoDatasetImporter.data_path

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetImporter.labels_path

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetImporter.include_all_data

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#include_all_data

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetImporter.__init__

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetImporter._info

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetImporter._cvat_task_labels

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#_cvat_task_labels

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetImporter._video_paths_map

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#_video_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetImporter._labels_paths_map

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#_labels_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetImporter._uuids

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetImporter._iter_uuids

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#_iter_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetImporter._num_samples

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetImporter.__iter__

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetImporter.__len__

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.cvat.CVATVideoDatasetImporter.__next__

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.cvat.CVATVideoDatasetImporter.has_dataset_info

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.cvat.CVATVideoDatasetImporter.has_video_metadata

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.VideoMetadata instances for each video.
fiftyone.utils.cvat.CVATVideoDatasetImporter.label_cls

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer within the sample-level labels that it produces.
fiftyone.utils.cvat.CVATVideoDatasetImporter.frame_labels_cls

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#frame_labels_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer within the frame labels that it produces.
fiftyone.utils.cvat.CVATVideoDatasetImporter.setup

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.cvat.CVATVideoDatasetImporter.get_dataset_info

fiftyone.utils.cvat.CVATVideoDatasetImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.cvat.CVATImageDatasetExporter

fiftyone.utils.cvat.CVATImageDatasetExporter.html

Class

Class

PUBLIC

Exporter that writes CVAT image datasets to disk.
fiftyone.utils.cvat.CVATImageDatasetExporter.data_path

fiftyone.utils.cvat.CVATImageDatasetExporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageDatasetExporter.labels_path

fiftyone.utils.cvat.CVATImageDatasetExporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageDatasetExporter.export_media

fiftyone.utils.cvat.CVATImageDatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageDatasetExporter.rel_dir

fiftyone.utils.cvat.CVATImageDatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageDatasetExporter.abs_paths

fiftyone.utils.cvat.CVATImageDatasetExporter.html#abs_paths

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageDatasetExporter.image_format

fiftyone.utils.cvat.CVATImageDatasetExporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageDatasetExporter.__init__

fiftyone.utils.cvat.CVATImageDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageDatasetExporter._name

fiftyone.utils.cvat.CVATImageDatasetExporter.html#_name

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATImageDatasetExporter._task_labels

fiftyone.utils.cvat.CVATImageDatasetExporter.html#_task_labels

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATImageDatasetExporter._cvat_images

fiftyone.utils.cvat.CVATImageDatasetExporter.html#_cvat_images

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATImageDatasetExporter._media_exporter

fiftyone.utils.cvat.CVATImageDatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATImageDatasetExporter.requires_image_metadata

fiftyone.utils.cvat.CVATImageDatasetExporter.html#requires_image_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.
fiftyone.utils.cvat.CVATImageDatasetExporter.label_cls

fiftyone.utils.cvat.CVATImageDatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) exported by this exporter.
fiftyone.utils.cvat.CVATImageDatasetExporter.setup

fiftyone.utils.cvat.CVATImageDatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.cvat.CVATImageDatasetExporter.log_collection

fiftyone.utils.cvat.CVATImageDatasetExporter.html#log_collection

Function

Method

PUBLIC

Logs any relevant information about the fiftyone.core.collections.SampleCollection whose samples will be exported.
fiftyone.utils.cvat.CVATImageDatasetExporter.export_sample

fiftyone.utils.cvat.CVATImageDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.cvat.CVATImageDatasetExporter.close

fiftyone.utils.cvat.CVATImageDatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.cvat.CVATVideoDatasetExporter

fiftyone.utils.cvat.CVATVideoDatasetExporter.html

Class

Class

PUBLIC

Exporter that writes CVAT video datasets to disk.
fiftyone.utils.cvat.CVATVideoDatasetExporter.data_path

fiftyone.utils.cvat.CVATVideoDatasetExporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetExporter.labels_path

fiftyone.utils.cvat.CVATVideoDatasetExporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetExporter.export_media

fiftyone.utils.cvat.CVATVideoDatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetExporter.rel_dir

fiftyone.utils.cvat.CVATVideoDatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetExporter.__init__

fiftyone.utils.cvat.CVATVideoDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetExporter._task_labels

fiftyone.utils.cvat.CVATVideoDatasetExporter.html#_task_labels

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetExporter._num_samples

fiftyone.utils.cvat.CVATVideoDatasetExporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetExporter._writer

fiftyone.utils.cvat.CVATVideoDatasetExporter.html#_writer

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetExporter._media_exporter

fiftyone.utils.cvat.CVATVideoDatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATVideoDatasetExporter.requires_video_metadata

fiftyone.utils.cvat.CVATVideoDatasetExporter.html#requires_video_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.VideoMetadata instances for each sample being exported.
fiftyone.utils.cvat.CVATVideoDatasetExporter.label_cls

fiftyone.utils.cvat.CVATVideoDatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) that can be exported at the sample-level.
fiftyone.utils.cvat.CVATVideoDatasetExporter.frame_labels_cls

fiftyone.utils.cvat.CVATVideoDatasetExporter.html#frame_labels_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) that can be exported by this exporter at the frame-level.
fiftyone.utils.cvat.CVATVideoDatasetExporter.setup

fiftyone.utils.cvat.CVATVideoDatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.cvat.CVATVideoDatasetExporter.log_collection

fiftyone.utils.cvat.CVATVideoDatasetExporter.html#log_collection

Function

Method

PUBLIC

Logs any relevant information about the fiftyone.core.collections.SampleCollection whose samples will be exported.
fiftyone.utils.cvat.CVATVideoDatasetExporter.export_sample

fiftyone.utils.cvat.CVATVideoDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.cvat.CVATVideoDatasetExporter.close

fiftyone.utils.cvat.CVATVideoDatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.cvat.CVATTaskLabels

fiftyone.utils.cvat.CVATTaskLabels.html

Class

Class

PUBLIC

Description of the labels in a CVAT image annotation task.
fiftyone.utils.cvat.CVATTaskLabels.labels

fiftyone.utils.cvat.CVATTaskLabels.html#labels

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATTaskLabels.__init__

fiftyone.utils.cvat.CVATTaskLabels.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATTaskLabels.merge_task_labels

fiftyone.utils.cvat.CVATTaskLabels.html#merge_task_labels

Function

Method

PUBLIC

Merges the given CVATTaskLabels into this instance.
fiftyone.utils.cvat.CVATTaskLabels.to_schema

fiftyone.utils.cvat.CVATTaskLabels.html#to_schema

Function

Method

PUBLIC

Returns an eta.core.image.ImageLabelsSchema representation of the task labels.
fiftyone.utils.cvat.CVATTaskLabels.from_cvat_images

fiftyone.utils.cvat.CVATTaskLabels.html#from_cvat_images

Function

Class Method

PUBLIC

Creates a CVATTaskLabels instance that describes the active schema of the given annotations.
fiftyone.utils.cvat.CVATTaskLabels.from_cvat_tracks

fiftyone.utils.cvat.CVATTaskLabels.html#from_cvat_tracks

Function

Class Method

PUBLIC

Creates a CVATTaskLabels instance that describes the active schema of the given annotations.
fiftyone.utils.cvat.CVATTaskLabels.from_labels_dict

fiftyone.utils.cvat.CVATTaskLabels.html#from_labels_dict

Function

Class Method

PUBLIC

Creates a CVATTaskLabels instance from the <labels> tag of a CVAT annotation XML file.
fiftyone.utils.cvat.CVATTaskLabels.from_schema

fiftyone.utils.cvat.CVATTaskLabels.html#from_schema

Function

Class Method

PUBLIC

Creates a CVATTaskLabels instance from an eta.core.image.ImageLabelsSchema.
fiftyone.utils.cvat.CVATImage

fiftyone.utils.cvat.CVATImage.html

Class

Class

PUBLIC

An annotated image in CVAT image format.
fiftyone.utils.cvat.CVATImage.tags

fiftyone.utils.cvat.CVATImage.html#tags

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImage.boxes

fiftyone.utils.cvat.CVATImage.html#boxes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImage.polygons

fiftyone.utils.cvat.CVATImage.html#polygons

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImage.polylines

fiftyone.utils.cvat.CVATImage.html#polylines

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImage.points

fiftyone.utils.cvat.CVATImage.html#points

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImage.subset

fiftyone.utils.cvat.CVATImage.html#subset

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImage.__init__

fiftyone.utils.cvat.CVATImage.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImage.id

fiftyone.utils.cvat.CVATImage.html#id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImage.name

fiftyone.utils.cvat.CVATImage.html#name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImage.width

fiftyone.utils.cvat.CVATImage.html#width

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImage.height

fiftyone.utils.cvat.CVATImage.html#height

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImage.has_tags

fiftyone.utils.cvat.CVATImage.html#has_tags

Attribute

Property

PUBLIC

Whether this image has tags.
fiftyone.utils.cvat.CVATImage.has_boxes

fiftyone.utils.cvat.CVATImage.html#has_boxes

Attribute

Property

PUBLIC

Whether this image has 2D boxes.
fiftyone.utils.cvat.CVATImage.has_polylines

fiftyone.utils.cvat.CVATImage.html#has_polylines

Attribute

Property

PUBLIC

Whether this image has polygons or polylines.
fiftyone.utils.cvat.CVATImage.has_points

fiftyone.utils.cvat.CVATImage.html#has_points

Attribute

Property

PUBLIC

Whether this image has keypoints.
fiftyone.utils.cvat.CVATImage.iter_annos

fiftyone.utils.cvat.CVATImage.html#iter_annos

Function

Method

PUBLIC

Returns an iterator over the annotations in the image.
fiftyone.utils.cvat.CVATImage.get_image_metadata

fiftyone.utils.cvat.CVATImage.html#get_image_metadata

Function

Method

PUBLIC

Returns a fiftyone.core.metadata.ImageMetadata instance for the annotations.
fiftyone.utils.cvat.CVATImage.to_labels

fiftyone.utils.cvat.CVATImage.html#to_labels

Function

Method

PUBLIC

Returns fiftyone.core.labels.Label representations of the annotations.
fiftyone.utils.cvat.CVATImage.from_labels

fiftyone.utils.cvat.CVATImage.html#from_labels

Function

Class Method

PUBLIC

Creates a CVATImage from a dictionary of labels.
fiftyone.utils.cvat.CVATImage.from_image_dict

fiftyone.utils.cvat.CVATImage.html#from_image_dict

Function

Class Method

PUBLIC

Creates a CVATImage from an <image> tag of a CVAT image annotations XML file.
fiftyone.utils.cvat.HasCVATBinaryMask

fiftyone.utils.cvat.HasCVATBinaryMask.html

Class

Class

PUBLIC

Mixin for CVAT annotations that store RLE format instance masks.
fiftyone.utils.cvat.HasCVATBinaryMask._rle_to_binary_image_mask

fiftyone.utils.cvat.HasCVATBinaryMask.html#_rle_to_binary_image_mask

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.cvat.HasCVATBinaryMask._mask_to_cvat_rle

fiftyone.utils.cvat.HasCVATBinaryMask.html#_mask_to_cvat_rle

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.cvat.HasCVATPoints

fiftyone.utils.cvat.HasCVATPoints.html

Class

Class

PUBLIC

Mixin for CVAT annotations that store a list of (x, y) pixel coordinates.
fiftyone.utils.cvat.HasCVATPoints.points

fiftyone.utils.cvat.HasCVATPoints.html#points

Attribute

Instance Variable

PUBLIC

a list of (x, y) pixel coordinates defining points
fiftyone.utils.cvat.HasCVATPoints.__init__

fiftyone.utils.cvat.HasCVATPoints.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.HasCVATPoints.points_str

fiftyone.utils.cvat.HasCVATPoints.html#points_str

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.cvat.HasCVATPoints._to_rel_points

fiftyone.utils.cvat.HasCVATPoints.html#_to_rel_points

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.cvat.HasCVATPoints._to_abs_points

fiftyone.utils.cvat.HasCVATPoints.html#_to_abs_points

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.cvat.HasCVATPoints._to_cvat_points_str

fiftyone.utils.cvat.HasCVATPoints.html#_to_cvat_points_str

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.cvat.HasCVATPoints._parse_cvat_points_str

fiftyone.utils.cvat.HasCVATPoints.html#_parse_cvat_points_str

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATImageAnno

fiftyone.utils.cvat.CVATImageAnno.html

Class

Class

PUBLIC

Mixin for annotations in CVAT image format.
fiftyone.utils.cvat.CVATImageAnno.occluded

fiftyone.utils.cvat.CVATImageAnno.html#occluded

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageAnno.attributes

fiftyone.utils.cvat.CVATImageAnno.html#attributes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageAnno.__init__

fiftyone.utils.cvat.CVATImageAnno.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageAnno._to_attributes

fiftyone.utils.cvat.CVATImageAnno.html#_to_attributes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATImageAnno._parse_attributes

fiftyone.utils.cvat.CVATImageAnno.html#_parse_attributes

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATImageAnno._parse_anno_dict

fiftyone.utils.cvat.CVATImageAnno.html#_parse_anno_dict

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATImageTag

fiftyone.utils.cvat.CVATImageTag.html

Class

Class

PUBLIC

A tag in CVAT image format.
fiftyone.utils.cvat.CVATImageTag.__init__

fiftyone.utils.cvat.CVATImageTag.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageTag.label

fiftyone.utils.cvat.CVATImageTag.html#label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageTag.to_classification

fiftyone.utils.cvat.CVATImageTag.html#to_classification

Function

Method

PUBLIC

Returns a fiftyone.core.labels.Classification representation of the tag.
fiftyone.utils.cvat.CVATImageTag.from_classification

fiftyone.utils.cvat.CVATImageTag.html#from_classification

Function

Class Method

PUBLIC

Creates a CVATImageTag from a fiftyone.core.labels.Classification.
fiftyone.utils.cvat.CVATImageTag.from_tag_dict

fiftyone.utils.cvat.CVATImageTag.html#from_tag_dict

Function

Class Method

PUBLIC

Creates a CVATImageTag from a <tag> tag of a CVAT image annotation XML file.
fiftyone.utils.cvat.CVATImageBox

fiftyone.utils.cvat.CVATImageBox.html

Class

Class

PUBLIC

An object bounding box in CVAT image format.
fiftyone.utils.cvat.CVATImageBox.__init__

fiftyone.utils.cvat.CVATImageBox.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageBox.label

fiftyone.utils.cvat.CVATImageBox.html#label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageBox.xtl

fiftyone.utils.cvat.CVATImageBox.html#xtl

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageBox.ytl

fiftyone.utils.cvat.CVATImageBox.html#ytl

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageBox.xbr

fiftyone.utils.cvat.CVATImageBox.html#xbr

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageBox.ybr

fiftyone.utils.cvat.CVATImageBox.html#ybr

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageBox.to_detection

fiftyone.utils.cvat.CVATImageBox.html#to_detection

Function

Method

PUBLIC

Returns a fiftyone.core.labels.Detection representation of the box.
fiftyone.utils.cvat.CVATImageBox.from_detection

fiftyone.utils.cvat.CVATImageBox.html#from_detection

Function

Class Method

PUBLIC

Creates a CVATImageBox from a fiftyone.core.labels.Detection.
fiftyone.utils.cvat.CVATImageBox.from_box_dict

fiftyone.utils.cvat.CVATImageBox.html#from_box_dict

Function

Class Method

PUBLIC

Creates a CVATImageBox from a <box> tag of a CVAT image annotation XML file.
fiftyone.utils.cvat.CVATImagePolygon

fiftyone.utils.cvat.CVATImagePolygon.html

Class

Class

PUBLIC

A polygon in CVAT image format.
fiftyone.utils.cvat.CVATImagePolygon.__init__

fiftyone.utils.cvat.CVATImagePolygon.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImagePolygon.label

fiftyone.utils.cvat.CVATImagePolygon.html#label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImagePolygon.to_polyline

fiftyone.utils.cvat.CVATImagePolygon.html#to_polyline

Function

Method

PUBLIC

Returns a fiftyone.core.labels.Polyline representation of the polygon.
fiftyone.utils.cvat.CVATImagePolygon.from_polyline

fiftyone.utils.cvat.CVATImagePolygon.html#from_polyline

Function

Class Method

PUBLIC

Creates a CVATImagePolygon from a fiftyone.core.labels.Polyline.
fiftyone.utils.cvat.CVATImagePolygon.from_polygon_dict

fiftyone.utils.cvat.CVATImagePolygon.html#from_polygon_dict

Function

Class Method

PUBLIC

Creates a CVATImagePolygon from a <polygon> tag of a CVAT image annotation XML file.
fiftyone.utils.cvat.CVATImagePolyline

fiftyone.utils.cvat.CVATImagePolyline.html

Class

Class

PUBLIC

A polyline in CVAT image format.
fiftyone.utils.cvat.CVATImagePolyline.__init__

fiftyone.utils.cvat.CVATImagePolyline.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImagePolyline.label

fiftyone.utils.cvat.CVATImagePolyline.html#label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImagePolyline.to_polyline

fiftyone.utils.cvat.CVATImagePolyline.html#to_polyline

Function

Method

PUBLIC

Returns a fiftyone.core.labels.Polyline representation of the polyline.
fiftyone.utils.cvat.CVATImagePolyline.from_polyline

fiftyone.utils.cvat.CVATImagePolyline.html#from_polyline

Function

Class Method

PUBLIC

Creates a CVATImagePolyline from a fiftyone.core.labels.Polyline.
fiftyone.utils.cvat.CVATImagePolyline.from_polyline_dict

fiftyone.utils.cvat.CVATImagePolyline.html#from_polyline_dict

Function

Class Method

PUBLIC

Creates a CVATImagePolyline from a <polyline> tag of a CVAT image annotation XML file.
fiftyone.utils.cvat.CVATImagePoints

fiftyone.utils.cvat.CVATImagePoints.html

Class

Class

PUBLIC

A set of keypoints in CVAT image format.
fiftyone.utils.cvat.CVATImagePoints.__init__

fiftyone.utils.cvat.CVATImagePoints.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImagePoints.label

fiftyone.utils.cvat.CVATImagePoints.html#label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImagePoints.to_keypoint

fiftyone.utils.cvat.CVATImagePoints.html#to_keypoint

Function

Method

PUBLIC

Returns a fiftyone.core.labels.Keypoint representation of the points.
fiftyone.utils.cvat.CVATImagePoints.from_keypoint

fiftyone.utils.cvat.CVATImagePoints.html#from_keypoint

Function

Class Method

PUBLIC

Creates a CVATImagePoints from a fiftyone.core.labels.Keypoint.
fiftyone.utils.cvat.CVATImagePoints.from_points_dict

fiftyone.utils.cvat.CVATImagePoints.html#from_points_dict

Function

Class Method

PUBLIC

Creates a CVATImagePoints from a <points> tag of a CVAT image annotation XML file.
fiftyone.utils.cvat.CVATTrack

fiftyone.utils.cvat.CVATTrack.html

Class

Class

PUBLIC

An annotation track in CVAT video format.
fiftyone.utils.cvat.CVATTrack.boxes

fiftyone.utils.cvat.CVATTrack.html#boxes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATTrack.polygons

fiftyone.utils.cvat.CVATTrack.html#polygons

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATTrack.polylines

fiftyone.utils.cvat.CVATTrack.html#polylines

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATTrack.points

fiftyone.utils.cvat.CVATTrack.html#points

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATTrack.__init__

fiftyone.utils.cvat.CVATTrack.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATTrack.id

fiftyone.utils.cvat.CVATTrack.html#id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATTrack.label

fiftyone.utils.cvat.CVATTrack.html#label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATTrack.width

fiftyone.utils.cvat.CVATTrack.html#width

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATTrack.height

fiftyone.utils.cvat.CVATTrack.html#height

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATTrack.has_boxes

fiftyone.utils.cvat.CVATTrack.html#has_boxes

Attribute

Property

PUBLIC

Whether this track has 2D boxes.
fiftyone.utils.cvat.CVATTrack.has_polylines

fiftyone.utils.cvat.CVATTrack.html#has_polylines

Attribute

Property

PUBLIC

Whether this track has polygons or polylines.
fiftyone.utils.cvat.CVATTrack.has_points

fiftyone.utils.cvat.CVATTrack.html#has_points

Attribute

Property

PUBLIC

Whether this track has keypoints.
fiftyone.utils.cvat.CVATTrack.iter_annos

fiftyone.utils.cvat.CVATTrack.html#iter_annos

Function

Method

PUBLIC

Returns an iterator over the annotations in the track.
fiftyone.utils.cvat.CVATTrack.to_labels

fiftyone.utils.cvat.CVATTrack.html#to_labels

Function

Method

PUBLIC

Returns fiftyone.core.labels.Label representations of the annotations.
fiftyone.utils.cvat.CVATTrack.from_labels

fiftyone.utils.cvat.CVATTrack.html#from_labels

Function

Class Method

PUBLIC

Creates a CVATTrack from a dictionary of labels.
fiftyone.utils.cvat.CVATTrack.from_track_dict

fiftyone.utils.cvat.CVATTrack.html#from_track_dict

Function

Class Method

PUBLIC

Creates a CVATTrack from a <track> tag of a CVAT video annotation XML file.
fiftyone.utils.cvat.CVATTrack._add_outside_shapes

fiftyone.utils.cvat.CVATTrack.html#_add_outside_shapes

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATVideoAnno

fiftyone.utils.cvat.CVATVideoAnno.html

Class

Class

PUBLIC

Mixin for annotations in CVAT video format.
fiftyone.utils.cvat.CVATVideoAnno.outside

fiftyone.utils.cvat.CVATVideoAnno.html#outside

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoAnno.occluded

fiftyone.utils.cvat.CVATVideoAnno.html#occluded

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoAnno.keyframe

fiftyone.utils.cvat.CVATVideoAnno.html#keyframe

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoAnno.attributes

fiftyone.utils.cvat.CVATVideoAnno.html#attributes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoAnno.__init__

fiftyone.utils.cvat.CVATVideoAnno.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoAnno._to_attributes

fiftyone.utils.cvat.CVATVideoAnno.html#_to_attributes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATVideoAnno._parse_attributes

fiftyone.utils.cvat.CVATVideoAnno.html#_parse_attributes

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATVideoAnno._parse_anno_dict

fiftyone.utils.cvat.CVATVideoAnno.html#_parse_anno_dict

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATVideoBox

fiftyone.utils.cvat.CVATVideoBox.html

Class

Class

PUBLIC

An object bounding box in CVAT video format.
fiftyone.utils.cvat.CVATVideoBox.__init__

fiftyone.utils.cvat.CVATVideoBox.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoBox.frame

fiftyone.utils.cvat.CVATVideoBox.html#frame

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoBox.label

fiftyone.utils.cvat.CVATVideoBox.html#label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoBox.xtl

fiftyone.utils.cvat.CVATVideoBox.html#xtl

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoBox.ytl

fiftyone.utils.cvat.CVATVideoBox.html#ytl

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoBox.xbr

fiftyone.utils.cvat.CVATVideoBox.html#xbr

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoBox.ybr

fiftyone.utils.cvat.CVATVideoBox.html#ybr

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoBox.to_detection

fiftyone.utils.cvat.CVATVideoBox.html#to_detection

Function

Method

PUBLIC

Returns a fiftyone.core.labels.Detection representation of the box.
fiftyone.utils.cvat.CVATVideoBox.from_detection

fiftyone.utils.cvat.CVATVideoBox.html#from_detection

Function

Class Method

PUBLIC

Creates a CVATVideoBox from a fiftyone.core.labels.Detection.
fiftyone.utils.cvat.CVATVideoBox.from_box_dict

fiftyone.utils.cvat.CVATVideoBox.html#from_box_dict

Function

Class Method

PUBLIC

Creates a CVATVideoBox from a <box> tag of a CVAT video annotation XML file.
fiftyone.utils.cvat.CVATVideoPolygon

fiftyone.utils.cvat.CVATVideoPolygon.html

Class

Class

PUBLIC

A polygon in CVAT video format.
fiftyone.utils.cvat.CVATVideoPolygon.__init__

fiftyone.utils.cvat.CVATVideoPolygon.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoPolygon.frame

fiftyone.utils.cvat.CVATVideoPolygon.html#frame

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoPolygon.label

fiftyone.utils.cvat.CVATVideoPolygon.html#label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoPolygon.to_polyline

fiftyone.utils.cvat.CVATVideoPolygon.html#to_polyline

Function

Method

PUBLIC

Returns a fiftyone.core.labels.Polyline representation of the polygon.
fiftyone.utils.cvat.CVATVideoPolygon.from_polyline

fiftyone.utils.cvat.CVATVideoPolygon.html#from_polyline

Function

Class Method

PUBLIC

Creates a CVATVideoPolygon from a fiftyone.core.labels.Polyline.
fiftyone.utils.cvat.CVATVideoPolygon.from_polygon_dict

fiftyone.utils.cvat.CVATVideoPolygon.html#from_polygon_dict

Function

Class Method

PUBLIC

Creates a CVATVideoPolygon from a <polygon> tag of a CVAT video annotation XML file.
fiftyone.utils.cvat.CVATVideoPolyline

fiftyone.utils.cvat.CVATVideoPolyline.html

Class

Class

PUBLIC

A polyline in CVAT video format.
fiftyone.utils.cvat.CVATVideoPolyline.__init__

fiftyone.utils.cvat.CVATVideoPolyline.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoPolyline.frame

fiftyone.utils.cvat.CVATVideoPolyline.html#frame

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoPolyline.label

fiftyone.utils.cvat.CVATVideoPolyline.html#label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoPolyline.to_polyline

fiftyone.utils.cvat.CVATVideoPolyline.html#to_polyline

Function

Method

PUBLIC

Returns a fiftyone.core.labels.Polyline representation of the polyline.
fiftyone.utils.cvat.CVATVideoPolyline.from_polyline

fiftyone.utils.cvat.CVATVideoPolyline.html#from_polyline

Function

Class Method

PUBLIC

Creates a CVATVideoPolyline from a fiftyone.core.labels.Polyline.
fiftyone.utils.cvat.CVATVideoPolyline.from_polyline_dict

fiftyone.utils.cvat.CVATVideoPolyline.html#from_polyline_dict

Function

Class Method

PUBLIC

Creates a CVATVideoPolyline from a <polyline> tag of a CVAT video annotation XML file.
fiftyone.utils.cvat.CVATVideoPoints

fiftyone.utils.cvat.CVATVideoPoints.html

Class

Class

PUBLIC

A set of keypoints in CVAT video format.
fiftyone.utils.cvat.CVATVideoPoints.__init__

fiftyone.utils.cvat.CVATVideoPoints.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoPoints.frame

fiftyone.utils.cvat.CVATVideoPoints.html#frame

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoPoints.label

fiftyone.utils.cvat.CVATVideoPoints.html#label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoPoints.to_keypoint

fiftyone.utils.cvat.CVATVideoPoints.html#to_keypoint

Function

Method

PUBLIC

Returns a fiftyone.core.labels.Keypoint representation of the points.
fiftyone.utils.cvat.CVATVideoPoints.from_keypoint

fiftyone.utils.cvat.CVATVideoPoints.html#from_keypoint

Function

Class Method

PUBLIC

Creates a CVATVideoPoints from a fiftyone.core.labels.Keypoint.
fiftyone.utils.cvat.CVATVideoPoints.from_points_dict

fiftyone.utils.cvat.CVATVideoPoints.html#from_points_dict

Function

Class Method

PUBLIC

Creates a CVATVideoPoints from a <points> tag of a CVAT video annotation XML file.
fiftyone.utils.cvat.CVATAttribute

fiftyone.utils.cvat.CVATAttribute.html

Class

Class

PUBLIC

An attribute in CVAT image format.
fiftyone.utils.cvat.CVATAttribute.__init__

fiftyone.utils.cvat.CVATAttribute.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAttribute.name

fiftyone.utils.cvat.CVATAttribute.html#name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAttribute.value

fiftyone.utils.cvat.CVATAttribute.html#value

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAttribute.to_eta_attribute

fiftyone.utils.cvat.CVATAttribute.html#to_eta_attribute

Function

Method

PUBLIC

Returns an eta.core.data.Attribute representation of the attribute.
fiftyone.utils.cvat.CVATAttribute.to_attribute

fiftyone.utils.cvat.CVATAttribute.html#to_attribute

Function

Method

PUBLIC

Returns a fiftyone.core.labels.Attribute representation of the attribute.
fiftyone.utils.cvat.CVATImageAnnotationWriter

fiftyone.utils.cvat.CVATImageAnnotationWriter.html

Class

Class

PUBLIC

Class for writing annotations in CVAT image format.
fiftyone.utils.cvat.CVATImageAnnotationWriter.__init__

fiftyone.utils.cvat.CVATImageAnnotationWriter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageAnnotationWriter.template

fiftyone.utils.cvat.CVATImageAnnotationWriter.html#template

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATImageAnnotationWriter.write

fiftyone.utils.cvat.CVATImageAnnotationWriter.html#write

Function

Method

PUBLIC

Writes the annotations to disk.
fiftyone.utils.cvat.CVATVideoAnnotationWriter

fiftyone.utils.cvat.CVATVideoAnnotationWriter.html

Class

Class

PUBLIC

Class for writing annotations in CVAT video format.
fiftyone.utils.cvat.CVATVideoAnnotationWriter.__init__

fiftyone.utils.cvat.CVATVideoAnnotationWriter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoAnnotationWriter.template

fiftyone.utils.cvat.CVATVideoAnnotationWriter.html#template

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATVideoAnnotationWriter.write

fiftyone.utils.cvat.CVATVideoAnnotationWriter.html#write

Function

Method

PUBLIC

Writes the annotations to disk.
fiftyone.utils.cvat.CVATBackendConfig

fiftyone.utils.cvat.CVATBackendConfig.html

Class

Class

PUBLIC

Class for configuring CVATBackend instances.
fiftyone.utils.cvat.CVATBackendConfig.url

fiftyone.utils.cvat.CVATBackendConfig.html#url

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.task_size

fiftyone.utils.cvat.CVATBackendConfig.html#task_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.segment_size

fiftyone.utils.cvat.CVATBackendConfig.html#segment_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.image_quality

fiftyone.utils.cvat.CVATBackendConfig.html#image_quality

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.use_cache

fiftyone.utils.cvat.CVATBackendConfig.html#use_cache

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.use_zip_chunks

fiftyone.utils.cvat.CVATBackendConfig.html#use_zip_chunks

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.chunk_size

fiftyone.utils.cvat.CVATBackendConfig.html#chunk_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.task_assignee

fiftyone.utils.cvat.CVATBackendConfig.html#task_assignee

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.job_assignees

fiftyone.utils.cvat.CVATBackendConfig.html#job_assignees

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.job_reviewers

fiftyone.utils.cvat.CVATBackendConfig.html#job_reviewers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.project_name

fiftyone.utils.cvat.CVATBackendConfig.html#project_name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.project_id

fiftyone.utils.cvat.CVATBackendConfig.html#project_id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.task_name

fiftyone.utils.cvat.CVATBackendConfig.html#task_name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.occluded_attr

fiftyone.utils.cvat.CVATBackendConfig.html#occluded_attr

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.group_id_attr

fiftyone.utils.cvat.CVATBackendConfig.html#group_id_attr

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.issue_tracker

fiftyone.utils.cvat.CVATBackendConfig.html#issue_tracker

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.organization

fiftyone.utils.cvat.CVATBackendConfig.html#organization

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.frame_start

fiftyone.utils.cvat.CVATBackendConfig.html#frame_start

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.frame_stop

fiftyone.utils.cvat.CVATBackendConfig.html#frame_stop

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.frame_step

fiftyone.utils.cvat.CVATBackendConfig.html#frame_step

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.__init__

fiftyone.utils.cvat.CVATBackendConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig._username

fiftyone.utils.cvat.CVATBackendConfig.html#_username

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATBackendConfig._email

fiftyone.utils.cvat.CVATBackendConfig.html#_email

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATBackendConfig._password

fiftyone.utils.cvat.CVATBackendConfig.html#_password

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATBackendConfig._headers

fiftyone.utils.cvat.CVATBackendConfig.html#_headers

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.username

fiftyone.utils.cvat.CVATBackendConfig.html#username

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.username.setter

fiftyone.utils.cvat.CVATBackendConfig.html#username.setter

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.email

fiftyone.utils.cvat.CVATBackendConfig.html#email

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.email.setter

fiftyone.utils.cvat.CVATBackendConfig.html#email.setter

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.password

fiftyone.utils.cvat.CVATBackendConfig.html#password

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.password.setter

fiftyone.utils.cvat.CVATBackendConfig.html#password.setter

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.headers

fiftyone.utils.cvat.CVATBackendConfig.html#headers

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.headers.setter

fiftyone.utils.cvat.CVATBackendConfig.html#headers.setter

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATBackendConfig.load_credentials

fiftyone.utils.cvat.CVATBackendConfig.html#load_credentials

Function

Method

PUBLIC

Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config.
fiftyone.utils.cvat.CVATBackend

fiftyone.utils.cvat.CVATBackend.html

Class

Class

PUBLIC

Class for interacting with the CVAT annotation backend.
fiftyone.utils.cvat.CVATBackend.supported_media_types

fiftyone.utils.cvat.CVATBackend.html#supported_media_types

Attribute

Property

PUBLIC

The list of media types that this backend supports.
fiftyone.utils.cvat.CVATBackend.supported_label_types

fiftyone.utils.cvat.CVATBackend.html#supported_label_types

Attribute

Property

PUBLIC

The list of label types supported by the backend.
fiftyone.utils.cvat.CVATBackend.supported_scalar_types

fiftyone.utils.cvat.CVATBackend.html#supported_scalar_types

Attribute

Property

PUBLIC

The list of scalar field types supported by the backend.
fiftyone.utils.cvat.CVATBackend.supported_attr_types

fiftyone.utils.cvat.CVATBackend.html#supported_attr_types

Attribute

Property

PUBLIC

The list of attribute types supported by the backend.
fiftyone.utils.cvat.CVATBackend.supports_clips_views

fiftyone.utils.cvat.CVATBackend.html#supports_clips_views

Attribute

Property

PUBLIC

Whether this backend supports annotating clips views.
fiftyone.utils.cvat.CVATBackend.supports_keyframes

fiftyone.utils.cvat.CVATBackend.html#supports_keyframes

Attribute

Property

PUBLIC

Whether this backend supports uploading only keyframes when editing existing video track annotations.
fiftyone.utils.cvat.CVATBackend.supports_video_sample_fields

fiftyone.utils.cvat.CVATBackend.html#supports_video_sample_fields

Attribute

Property

PUBLIC

Whether this backend supports annotating video labels at a sample-level.
fiftyone.utils.cvat.CVATBackend.requires_label_schema

fiftyone.utils.cvat.CVATBackend.html#requires_label_schema

Attribute

Property

PUBLIC

Whether this backend requires a pre-defined label schema for its annotation runs.
fiftyone.utils.cvat.CVATBackend.recommend_attr_tool

fiftyone.utils.cvat.CVATBackend.html#recommend_attr_tool

Function

Method

PUBLIC

Recommends an attribute tool for an attribute with the given name and value.
fiftyone.utils.cvat.CVATBackend.requires_attr_values

fiftyone.utils.cvat.CVATBackend.html#requires_attr_values

Function

Method

PUBLIC

Determines whether the list of possible values are required for attributes of the given type.
fiftyone.utils.cvat.CVATBackend._connect_to_api

fiftyone.utils.cvat.CVATBackend.html#_connect_to_api

Function

Method

PRIVATE

Returns a new API instance connected to the annotation backend.
fiftyone.utils.cvat.CVATBackend.upload_annotations

fiftyone.utils.cvat.CVATBackend.html#upload_annotations

Function

Method

PUBLIC

Uploads the samples and relevant existing labels from the label schema to the annotation backend.
fiftyone.utils.cvat.CVATBackend.download_annotations

fiftyone.utils.cvat.CVATBackend.html#download_annotations

Function

Method

PUBLIC

Downloads the annotations from the annotation backend for the given results.
fiftyone.utils.cvat.CVATAnnotationResults

fiftyone.utils.cvat.CVATAnnotationResults.html

Class

Class

PUBLIC

Class that stores all relevant information needed to monitor the progress of an annotation run sent to CVAT and download the results.
fiftyone.utils.cvat.CVATAnnotationResults.__init__

fiftyone.utils.cvat.CVATAnnotationResults.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationResults.server_id_map

fiftyone.utils.cvat.CVATAnnotationResults.html#server_id_map

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationResults.project_ids

fiftyone.utils.cvat.CVATAnnotationResults.html#project_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationResults.task_ids

fiftyone.utils.cvat.CVATAnnotationResults.html#task_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationResults.job_ids

fiftyone.utils.cvat.CVATAnnotationResults.html#job_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationResults.frame_id_map

fiftyone.utils.cvat.CVATAnnotationResults.html#frame_id_map

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationResults.labels_task_map

fiftyone.utils.cvat.CVATAnnotationResults.html#labels_task_map

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationResults.launch_editor

fiftyone.utils.cvat.CVATAnnotationResults.html#launch_editor

Function

Method

PUBLIC

Launches the CVAT editor and loads the first task for this annotation run.
fiftyone.utils.cvat.CVATAnnotationResults.get_status

fiftyone.utils.cvat.CVATAnnotationResults.html#get_status

Function

Method

PUBLIC

Gets the status of the assigned tasks and jobs.
fiftyone.utils.cvat.CVATAnnotationResults.print_status

fiftyone.utils.cvat.CVATAnnotationResults.html#print_status

Function

Method

PUBLIC

Prints the status of the assigned tasks and jobs.
fiftyone.utils.cvat.CVATAnnotationResults.delete_tasks

fiftyone.utils.cvat.CVATAnnotationResults.html#delete_tasks

Function

Method

PUBLIC

Deletes the given tasks from both the CVAT server and this run.
fiftyone.utils.cvat.CVATAnnotationResults.cleanup

fiftyone.utils.cvat.CVATAnnotationResults.html#cleanup

Function

Method

PUBLIC

Deletes all tasks and created projects associated with this run.
fiftyone.utils.cvat.CVATAnnotationResults.id_map

fiftyone.utils.cvat.CVATAnnotationResults.html#id_map

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationResults._forget_tasks

fiftyone.utils.cvat.CVATAnnotationResults.html#_forget_tasks

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationResults._get_status

fiftyone.utils.cvat.CVATAnnotationResults.html#_get_status

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationResults._from_dict

fiftyone.utils.cvat.CVATAnnotationResults.html#_from_dict

Function

Class Method

PRIVATE

Builds an AnnotationResults from a JSON dict representation of it.
fiftyone.utils.cvat.CVATAnnotationAPI

fiftyone.utils.cvat.CVATAnnotationAPI.html

Class

Class

PUBLIC

A class to facilitate connection to and management of tasks in CVAT.
fiftyone.utils.cvat.CVATAnnotationAPI.__init__

fiftyone.utils.cvat.CVATAnnotationAPI.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._name

fiftyone.utils.cvat.CVATAnnotationAPI.html#_name

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._url

fiftyone.utils.cvat.CVATAnnotationAPI.html#_url

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._username

fiftyone.utils.cvat.CVATAnnotationAPI.html#_username

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._email

fiftyone.utils.cvat.CVATAnnotationAPI.html#_email

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._password

fiftyone.utils.cvat.CVATAnnotationAPI.html#_password

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._headers

fiftyone.utils.cvat.CVATAnnotationAPI.html#_headers

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._organization

fiftyone.utils.cvat.CVATAnnotationAPI.html#_organization

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._server_version

fiftyone.utils.cvat.CVATAnnotationAPI.html#_server_version

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._session

fiftyone.utils.cvat.CVATAnnotationAPI.html#_session

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._user_id_map

fiftyone.utils.cvat.CVATAnnotationAPI.html#_user_id_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._project_id_map

fiftyone.utils.cvat.CVATAnnotationAPI.html#_project_id_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.server_version

fiftyone.utils.cvat.CVATAnnotationAPI.html#server_version

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.base_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#base_url

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.base_api_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#base_api_url

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.login_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#login_url

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.about_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#about_url

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.users_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#users_url

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.projects_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#projects_url

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.projects_page_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#projects_page_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.project_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#project_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.tasks_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#tasks_url

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.tasks_page_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#tasks_page_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.task_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#task_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.task_status_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#task_status_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.task_data_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#task_data_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.task_data_download_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#task_data_download_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.task_data_meta_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#task_data_meta_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.task_annotation_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#task_annotation_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.task_annotation_formatted_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#task_annotation_formatted_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.labels_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#labels_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.jobs_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#jobs_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.job_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#job_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.job_annotation_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#job_annotation_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.taskless_job_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#taskless_job_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.base_task_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#base_task_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.base_job_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#base_job_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.task_id_search_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#task_id_search_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.user_search_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#user_search_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.project_search_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#project_search_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.project_id_search_url

fiftyone.utils.cvat.CVATAnnotationAPI.html#project_id_search_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.assignee_key

fiftyone.utils.cvat.CVATAnnotationAPI.html#assignee_key

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._parse_reviewers

fiftyone.utils.cvat.CVATAnnotationAPI.html#_parse_reviewers

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._setup

fiftyone.utils.cvat.CVATAnnotationAPI.html#_setup

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._add_referer

fiftyone.utils.cvat.CVATAnnotationAPI.html#_add_referer

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._add_organization

fiftyone.utils.cvat.CVATAnnotationAPI.html#_add_organization

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.close

fiftyone.utils.cvat.CVATAnnotationAPI.html#close

Function

Method

PUBLIC

Closes the API session.
fiftyone.utils.cvat.CVATAnnotationAPI._login

fiftyone.utils.cvat.CVATAnnotationAPI.html#_login

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._make_request

fiftyone.utils.cvat.CVATAnnotationAPI.html#_make_request

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.get

fiftyone.utils.cvat.CVATAnnotationAPI.html#get

Function

Method

PUBLIC

Sends a GET request to the given CVAT API URL.
fiftyone.utils.cvat.CVATAnnotationAPI.patch

fiftyone.utils.cvat.CVATAnnotationAPI.html#patch

Function

Method

PUBLIC

Sends a PATCH request to the given CVAT API URL.
fiftyone.utils.cvat.CVATAnnotationAPI.post

fiftyone.utils.cvat.CVATAnnotationAPI.html#post

Function

Method

PUBLIC

Sends a POST request to the given CVAT API URL.
fiftyone.utils.cvat.CVATAnnotationAPI.put

fiftyone.utils.cvat.CVATAnnotationAPI.html#put

Function

Method

PUBLIC

Sends a PUT request to the given CVAT API URL.
fiftyone.utils.cvat.CVATAnnotationAPI.delete

fiftyone.utils.cvat.CVATAnnotationAPI.html#delete

Function

Method

PUBLIC

Sends a DELETE request to the given CVAT API URL.
fiftyone.utils.cvat.CVATAnnotationAPI.get_user_id

fiftyone.utils.cvat.CVATAnnotationAPI.html#get_user_id

Function

Method

PUBLIC

Retrieves the CVAT user ID for the given username.
fiftyone.utils.cvat.CVATAnnotationAPI.get_project_id

fiftyone.utils.cvat.CVATAnnotationAPI.html#get_project_id

Function

Method

PUBLIC

Retrieves the CVAT project ID for the first instance of the given project name.
fiftyone.utils.cvat.CVATAnnotationAPI.get_project_name

fiftyone.utils.cvat.CVATAnnotationAPI.html#get_project_name

Function

Method

PUBLIC

Retrieves the CVAT project name for the given project ID.
fiftyone.utils.cvat.CVATAnnotationAPI.get_empty_projects

fiftyone.utils.cvat.CVATAnnotationAPI.html#get_empty_projects

Function

Method

PUBLIC

Check all given project ids to determine if they are empty or if they contain at least one task.
fiftyone.utils.cvat.CVATAnnotationAPI._is_empty_project

fiftyone.utils.cvat.CVATAnnotationAPI.html#_is_empty_project

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.create_project

fiftyone.utils.cvat.CVATAnnotationAPI.html#create_project

Function

Method

PUBLIC

Creates a project on the CVAT server using the given label schema.
fiftyone.utils.cvat.CVATAnnotationAPI.list_projects

fiftyone.utils.cvat.CVATAnnotationAPI.html#list_projects

Function

Method

PUBLIC

Returns the list of project IDs.
fiftyone.utils.cvat.CVATAnnotationAPI.project_exists

fiftyone.utils.cvat.CVATAnnotationAPI.html#project_exists

Function

Method

PUBLIC

Checks if the given project exists.
fiftyone.utils.cvat.CVATAnnotationAPI.delete_project

fiftyone.utils.cvat.CVATAnnotationAPI.html#delete_project

Function

Method

PUBLIC

Deletes the given project from the CVAT server.
fiftyone.utils.cvat.CVATAnnotationAPI.delete_projects

fiftyone.utils.cvat.CVATAnnotationAPI.html#delete_projects

Function

Method

PUBLIC

Deletes the given projects from the CVAT server.
fiftyone.utils.cvat.CVATAnnotationAPI.get_project_tasks

fiftyone.utils.cvat.CVATAnnotationAPI.html#get_project_tasks

Function

Method

PUBLIC

Returns the IDs of the tasks in the given project.
fiftyone.utils.cvat.CVATAnnotationAPI.create_task

fiftyone.utils.cvat.CVATAnnotationAPI.html#create_task

Function

Method

PUBLIC

Creates a task on the CVAT server using the given label schema.
fiftyone.utils.cvat.CVATAnnotationAPI.list_tasks

fiftyone.utils.cvat.CVATAnnotationAPI.html#list_tasks

Function

Method

PUBLIC

Returns the list of task IDs.
fiftyone.utils.cvat.CVATAnnotationAPI.task_exists

fiftyone.utils.cvat.CVATAnnotationAPI.html#task_exists

Function

Method

PUBLIC

Checks if the given task exists.
fiftyone.utils.cvat.CVATAnnotationAPI.delete_task

fiftyone.utils.cvat.CVATAnnotationAPI.html#delete_task

Function

Method

PUBLIC

Deletes the given task from the CVAT server.
fiftyone.utils.cvat.CVATAnnotationAPI.delete_tasks

fiftyone.utils.cvat.CVATAnnotationAPI.html#delete_tasks

Function

Method

PUBLIC

Deletes the given tasks from the CVAT server.
fiftyone.utils.cvat.CVATAnnotationAPI.launch_editor

fiftyone.utils.cvat.CVATAnnotationAPI.html#launch_editor

Function

Method

PUBLIC

Launches the CVAT editor in your default web browser.
fiftyone.utils.cvat.CVATAnnotationAPI.upload_data

fiftyone.utils.cvat.CVATAnnotationAPI.html#upload_data

Function

Method

PUBLIC

Uploads a list of media to the task with the given ID.
fiftyone.utils.cvat.CVATAnnotationAPI._parse_local_files

fiftyone.utils.cvat.CVATAnnotationAPI.html#_parse_local_files

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI.upload_samples

fiftyone.utils.cvat.CVATAnnotationAPI.html#upload_samples

Function

Method

PUBLIC

Uploads the given samples to CVAT according to the given backend's annotation and server configuration.
fiftyone.utils.cvat.CVATAnnotationAPI.download_annotations

fiftyone.utils.cvat.CVATAnnotationAPI.html#download_annotations

Function

Method

PUBLIC

Download the annotations from the CVAT server for the given results instance and parses them into the appropriate FiftyOne types.
fiftyone.utils.cvat.CVATAnnotationAPI._get_attr_class_maps

fiftyone.utils.cvat.CVATAnnotationAPI.html#_get_attr_class_maps

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._get_paginated_results

fiftyone.utils.cvat.CVATAnnotationAPI.html#_get_paginated_results

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._get_value_from_search

fiftyone.utils.cvat.CVATAnnotationAPI.html#_get_value_from_search

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._get_value_update_map

fiftyone.utils.cvat.CVATAnnotationAPI.html#_get_value_update_map

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._get_project_labels

fiftyone.utils.cvat.CVATAnnotationAPI.html#_get_project_labels

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._get_task_labels

fiftyone.utils.cvat.CVATAnnotationAPI.html#_get_task_labels

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._get_task_id_labels_json

fiftyone.utils.cvat.CVATAnnotationAPI.html#_get_task_id_labels_json

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._get_job_ids

fiftyone.utils.cvat.CVATAnnotationAPI.html#_get_job_ids

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._parse_project_details

fiftyone.utils.cvat.CVATAnnotationAPI.html#_parse_project_details

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._get_label_schema

fiftyone.utils.cvat.CVATAnnotationAPI.html#_get_label_schema

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._get_cvat_schema

fiftyone.utils.cvat.CVATAnnotationAPI.html#_get_cvat_schema

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._convert_cvat_schema

fiftyone.utils.cvat.CVATAnnotationAPI.html#_convert_cvat_schema

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._has_ignored_attributes

fiftyone.utils.cvat.CVATAnnotationAPI.html#_has_ignored_attributes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._build_cvat_schema

fiftyone.utils.cvat.CVATAnnotationAPI.html#_build_cvat_schema

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._add_project_label_ids

fiftyone.utils.cvat.CVATAnnotationAPI.html#_add_project_label_ids

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._ensure_one_field_per_type

fiftyone.utils.cvat.CVATAnnotationAPI.html#_ensure_one_field_per_type

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._get_batch_size

fiftyone.utils.cvat.CVATAnnotationAPI.html#_get_batch_size

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._create_task_upload_data

fiftyone.utils.cvat.CVATAnnotationAPI.html#_create_task_upload_data

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._verify_uploaded_frames

fiftyone.utils.cvat.CVATAnnotationAPI.html#_verify_uploaded_frames

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._compute_expected_frames

fiftyone.utils.cvat.CVATAnnotationAPI.html#_compute_expected_frames

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._upload_annotations

fiftyone.utils.cvat.CVATAnnotationAPI.html#_upload_annotations

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._create_server_id_map

fiftyone.utils.cvat.CVATAnnotationAPI.html#_create_server_id_map

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._update_shapes_tags_tracks

fiftyone.utils.cvat.CVATAnnotationAPI.html#_update_shapes_tags_tracks

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._filter_field_classes

fiftyone.utils.cvat.CVATAnnotationAPI.html#_filter_field_classes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._get_return_label_types

fiftyone.utils.cvat.CVATAnnotationAPI.html#_get_return_label_types

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._get_ignored_types

fiftyone.utils.cvat.CVATAnnotationAPI.html#_get_ignored_types

Function

Method

PRIVATE

When uploading multiple fields to an existing project, each field must have a different type but can have overlapping class names. Therefore, when loading annotations, if a field exists for a found label type, that label will not be loaded with any other fields.
fiftyone.utils.cvat.CVATAnnotationAPI._convert_polylines_to_masks

fiftyone.utils.cvat.CVATAnnotationAPI.html#_convert_polylines_to_masks

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._convert_polylines

fiftyone.utils.cvat.CVATAnnotationAPI.html#_convert_polylines

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._merge_results

fiftyone.utils.cvat.CVATAnnotationAPI.html#_merge_results

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._parse_shapes_tags

fiftyone.utils.cvat.CVATAnnotationAPI.html#_parse_shapes_tags

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._parse_annotation

fiftyone.utils.cvat.CVATAnnotationAPI.html#_parse_annotation

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._get_segmentation_id

fiftyone.utils.cvat.CVATAnnotationAPI.html#_get_segmentation_id

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._add_label_to_results

fiftyone.utils.cvat.CVATAnnotationAPI.html#_add_label_to_results

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._parse_arg

fiftyone.utils.cvat.CVATAnnotationAPI.html#_parse_arg

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._to_cvat_attributes

fiftyone.utils.cvat.CVATAnnotationAPI.html#_to_cvat_attributes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._create_shapes_tags_tracks

fiftyone.utils.cvat.CVATAnnotationAPI.html#_create_shapes_tags_tracks

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._create_scalar_tags

fiftyone.utils.cvat.CVATAnnotationAPI.html#_create_scalar_tags

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._create_classification_tags

fiftyone.utils.cvat.CVATAnnotationAPI.html#_create_classification_tags

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._create_detection_shapes

fiftyone.utils.cvat.CVATAnnotationAPI.html#_create_detection_shapes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._create_keypoint_shapes

fiftyone.utils.cvat.CVATAnnotationAPI.html#_create_keypoint_shapes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._create_polyline_shapes

fiftyone.utils.cvat.CVATAnnotationAPI.html#_create_polyline_shapes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._create_segmentation_shapes

fiftyone.utils.cvat.CVATAnnotationAPI.html#_create_segmentation_shapes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._parse_label

fiftyone.utils.cvat.CVATAnnotationAPI.html#_parse_label

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._add_shapes_to_tracks

fiftyone.utils.cvat.CVATAnnotationAPI.html#_add_shapes_to_tracks

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._merge_tracks

fiftyone.utils.cvat.CVATAnnotationAPI.html#_merge_tracks

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._finalize_tracks

fiftyone.utils.cvat.CVATAnnotationAPI.html#_finalize_tracks

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._finalize_track

fiftyone.utils.cvat.CVATAnnotationAPI.html#_finalize_track

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._build_frame_id_map

fiftyone.utils.cvat.CVATAnnotationAPI.html#_build_frame_id_map

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._remap_ids

fiftyone.utils.cvat.CVATAnnotationAPI.html#_remap_ids

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._remap_track_ids

fiftyone.utils.cvat.CVATAnnotationAPI.html#_remap_track_ids

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATAnnotationAPI._validate

fiftyone.utils.cvat.CVATAnnotationAPI.html#_validate

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATLabel

fiftyone.utils.cvat.CVATLabel.html

Class

Class

PUBLIC

A label returned by the CVAT API.
fiftyone.utils.cvat.CVATLabel.attributes

fiftyone.utils.cvat.CVATLabel.html#attributes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATLabel.__init__

fiftyone.utils.cvat.CVATLabel.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATLabel.id

fiftyone.utils.cvat.CVATLabel.html#id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATLabel.label

fiftyone.utils.cvat.CVATLabel.html#label

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATLabel.fo_attributes

fiftyone.utils.cvat.CVATLabel.html#fo_attributes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATLabel._set_id

fiftyone.utils.cvat.CVATLabel.html#_set_id

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATLabel._set_attributes

fiftyone.utils.cvat.CVATLabel.html#_set_attributes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATShape

fiftyone.utils.cvat.CVATShape.html

Class

Class

PUBLIC

A shape returned by the CVAT API.
fiftyone.utils.cvat.CVATShape.index

fiftyone.utils.cvat.CVATShape.html#index

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATShape.__init__

fiftyone.utils.cvat.CVATShape.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATShape.frame_size

fiftyone.utils.cvat.CVATShape.html#frame_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATShape.points

fiftyone.utils.cvat.CVATShape.html#points

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.cvat.CVATShape._parse_named_attribute

fiftyone.utils.cvat.CVATShape.html#_parse_named_attribute

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATShape._to_pairs_of_points

fiftyone.utils.cvat.CVATShape.html#_to_pairs_of_points

Function

Method

PRIVATE

Undocumented
fiftyone.utils.cvat.CVATShape.to_detection

fiftyone.utils.cvat.CVATShape.html#to_detection

Function

Method

PUBLIC

Converts this shape to a fiftyone.core.labels.Detection.
fiftyone.utils.cvat.CVATShape.to_instance

fiftyone.utils.cvat.CVATShape.html#to_instance

Function

Method

PUBLIC

Converts this shape to a fiftyone.core.labels.Detection with instance mask.
fiftyone.utils.cvat.CVATShape.to_polyline

fiftyone.utils.cvat.CVATShape.html#to_polyline

Function

Method

PUBLIC

Converts this shape to a fiftyone.core.labels.Polyline.
fiftyone.utils.cvat.CVATShape.to_polylines

fiftyone.utils.cvat.CVATShape.html#to_polylines

Function

Method

PUBLIC

Converts this shape to a fiftyone.core.labels.Polylines.
fiftyone.utils.cvat.CVATShape.to_keypoint

fiftyone.utils.cvat.CVATShape.html#to_keypoint

Function

Method

PUBLIC

Converts this shape to a fiftyone.core.labels.Keypoint.
fiftyone.utils.cvat.CVATShape.polyline_to_detection

fiftyone.utils.cvat.CVATShape.html#polyline_to_detection

Function

Class Method

PUBLIC

Converts a fiftyone.core.labels.Polyline to a fiftyone.core.labels.Detection with a segmentation mask.
fiftyone.utils.cvat.CVATShape.polylines_to_segmentation

fiftyone.utils.cvat.CVATShape.html#polylines_to_segmentation

Function

Class Method

PUBLIC

Converts a fiftyone.core.labels.Polylines to a fiftyone.core.labels.Segmentation.
fiftyone.utils.cvat.CVATTag

fiftyone.utils.cvat.CVATTag.html

Class

Class

PUBLIC

A tag returned by the CVAT API.
fiftyone.utils.cvat.CVATTag.to_classification

fiftyone.utils.cvat.CVATTag.html#to_classification

Function

Method

PUBLIC

Converts the tag to a fiftyone.core.labels.Classification.
fiftyone.utils.cvat.load_cvat_image_annotations

fiftyone.utils.cvat.html#load_cvat_image_annotations

Function

Function

PUBLIC

Loads the CVAT image annotations from the given XML file.
fiftyone.utils.cvat.load_cvat_video_annotations

fiftyone.utils.cvat.html#load_cvat_video_annotations

Function

Function

PUBLIC

Loads the CVAT video annotations from the given XML file.
fiftyone.utils.cvat._is_supported_attribute_type

fiftyone.utils.cvat.html#_is_supported_attribute_type

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._cvat_tracks_to_frames_dict

fiftyone.utils.cvat.html#_cvat_tracks_to_frames_dict

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._frames_to_cvat_tracks

fiftyone.utils.cvat.html#_frames_to_cvat_tracks

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._get_single_polyline_points

fiftyone.utils.cvat.html#_get_single_polyline_points

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._ensure_list

fiftyone.utils.cvat.html#_ensure_list

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._stringify_value

fiftyone.utils.cvat.html#_stringify_value

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._to_int_bool

fiftyone.utils.cvat.html#_to_int_bool

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._from_int_bool

fiftyone.utils.cvat.html#_from_int_bool

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._parse_value

fiftyone.utils.cvat.html#_parse_value

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._parse_occlusion_value

fiftyone.utils.cvat.html#_parse_occlusion_value

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._get_interpolated_shapes

fiftyone.utils.cvat.html#_get_interpolated_shapes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._validate_frame_arg

fiftyone.utils.cvat.html#_validate_frame_arg

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._render_frame_arg

fiftyone.utils.cvat.html#_render_frame_arg

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._parse_frame_step

fiftyone.utils.cvat.html#_parse_frame_step

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._remap_annotation_frame

fiftyone.utils.cvat.html#_remap_annotation_frame

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._remap_annotation_frames

fiftyone.utils.cvat.html#_remap_annotation_frames

Function

Function

PRIVATE

Undocumented
fiftyone.utils.cvat._get_next_frame

fiftyone.utils.cvat.html#_get_next_frame

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.base.logger

fiftyone.utils.data.base.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.data.base.parse_images_dir

fiftyone.utils.data.base.html#parse_images_dir

Function

Function

PUBLIC

Parses the contents of the given directory of images.
fiftyone.utils.data.base.parse_videos_dir

fiftyone.utils.data.base.html#parse_videos_dir

Function

Function

PUBLIC

Parses the contents of the given directory of videos.
fiftyone.utils.data.base.parse_image_classification_dir_tree

fiftyone.utils.data.base.html#parse_image_classification_dir_tree

Function

Function

PUBLIC

Parses the contents of the given image classification dataset directory tree, which should have the following format:
fiftyone.utils.data.base.download_image_classification_dataset

fiftyone.utils.data.base.html#download_image_classification_dataset

Function

Function

PUBLIC

Downloads the classification dataset specified by the given CSV file, which should have the following format:
fiftyone.utils.data.base.download_images

fiftyone.utils.data.base.html#download_images

Function

Function

PUBLIC

Downloads the images from the given URLs.
fiftyone.utils.data.base._download_images

fiftyone.utils.data.base.html#_download_images

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.base._download_images_multi

fiftyone.utils.data.base.html#_download_images_multi

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.base._download_image

fiftyone.utils.data.base.html#_download_image

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.parsers.add_images

fiftyone.utils.data.parsers.html#add_images

Function

Function

PUBLIC

Adds the given images to the dataset.
fiftyone.utils.data.parsers.add_labeled_images

fiftyone.utils.data.parsers.html#add_labeled_images

Function

Function

PUBLIC

Adds the given labeled images to the dataset.
fiftyone.utils.data.parsers.add_videos

fiftyone.utils.data.parsers.html#add_videos

Function

Function

PUBLIC

Adds the given videos to the dataset.
fiftyone.utils.data.parsers.add_labeled_videos

fiftyone.utils.data.parsers.html#add_labeled_videos

Function

Function

PUBLIC

Adds the given labeled videos to the dataset.
fiftyone.utils.data.parsers.SampleParser

fiftyone.utils.data.parsers.SampleParser.html

Class

Class

PUBLIC

Base interface for sample parsers.
fiftyone.utils.data.parsers.SampleParser.__init__

fiftyone.utils.data.parsers.SampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.parsers.SampleParser._current_sample

fiftyone.utils.data.parsers.SampleParser.html#_current_sample

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.parsers.SampleParser.current_sample

fiftyone.utils.data.parsers.SampleParser.html#current_sample

Attribute

Property

PUBLIC

The current sample.
fiftyone.utils.data.parsers.SampleParser.with_sample

fiftyone.utils.data.parsers.SampleParser.html#with_sample

Function

Method

PUBLIC

Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample.
fiftyone.utils.data.parsers.SampleParser.clear_sample

fiftyone.utils.data.parsers.SampleParser.html#clear_sample

Function

Method

PUBLIC

Clears the current sample.
fiftyone.utils.data.parsers.UnlabeledImageSampleParser

fiftyone.utils.data.parsers.UnlabeledImageSampleParser.html

Class

Class

PUBLIC

Interface for SampleParser instances that parse unlabeled image samples.
fiftyone.utils.data.parsers.UnlabeledImageSampleParser.has_image_path

fiftyone.utils.data.parsers.UnlabeledImageSampleParser.html#has_image_path

Attribute

Property

PUBLIC

Whether this parser produces paths to images on disk for samples that it parses.
fiftyone.utils.data.parsers.UnlabeledImageSampleParser.has_image_metadata

fiftyone.utils.data.parsers.UnlabeledImageSampleParser.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.ImageMetadata instances for samples that it parses.
fiftyone.utils.data.parsers.UnlabeledImageSampleParser.get_image

fiftyone.utils.data.parsers.UnlabeledImageSampleParser.html#get_image

Function

Method

PUBLIC

Returns the image from the current sample.
fiftyone.utils.data.parsers.UnlabeledImageSampleParser.get_image_path

fiftyone.utils.data.parsers.UnlabeledImageSampleParser.html#get_image_path

Function

Method

PUBLIC

Returns the image path for the current sample.
fiftyone.utils.data.parsers.UnlabeledImageSampleParser.get_image_metadata

fiftyone.utils.data.parsers.UnlabeledImageSampleParser.html#get_image_metadata

Function

Method

PUBLIC

Returns the image metadata for the current sample.
fiftyone.utils.data.parsers.UnlabeledVideoSampleParser

fiftyone.utils.data.parsers.UnlabeledVideoSampleParser.html

Class

Class

PUBLIC

Interface for SampleParser instances that parse unlabeled video samples.
fiftyone.utils.data.parsers.UnlabeledVideoSampleParser.has_video_metadata

fiftyone.utils.data.parsers.UnlabeledVideoSampleParser.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.VideoMetadata instances for samples that it parses.
fiftyone.utils.data.parsers.UnlabeledVideoSampleParser.get_video_path

fiftyone.utils.data.parsers.UnlabeledVideoSampleParser.html#get_video_path

Function

Method

PUBLIC

Returns the video path for the current sample.
fiftyone.utils.data.parsers.UnlabeledVideoSampleParser.get_video_metadata

fiftyone.utils.data.parsers.UnlabeledVideoSampleParser.html#get_video_metadata

Function

Method

PUBLIC

Returns the video metadata for the current sample.
fiftyone.utils.data.parsers.UnlabeledMediaSampleParser

fiftyone.utils.data.parsers.UnlabeledMediaSampleParser.html

Class

Class

PUBLIC

Interface for SampleParser instances that parse unlabeled media samples.
fiftyone.utils.data.parsers.UnlabeledMediaSampleParser.has_metadata

fiftyone.utils.data.parsers.UnlabeledMediaSampleParser.html#has_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.Metadata instances for samples that it parses.
fiftyone.utils.data.parsers.UnlabeledMediaSampleParser.get_media_path

fiftyone.utils.data.parsers.UnlabeledMediaSampleParser.html#get_media_path

Function

Method

PUBLIC

Returns the media path for the current sample.
fiftyone.utils.data.parsers.UnlabeledMediaSampleParser.get_metadata

fiftyone.utils.data.parsers.UnlabeledMediaSampleParser.html#get_metadata

Function

Method

PUBLIC

Returns the metadata for the current sample.
fiftyone.utils.data.parsers.ImageSampleParser

fiftyone.utils.data.parsers.ImageSampleParser.html

Class

Class

PUBLIC

Sample parser that parses unlabeled image samples.
fiftyone.utils.data.parsers.ImageSampleParser.has_image_path

fiftyone.utils.data.parsers.ImageSampleParser.html#has_image_path

Attribute

Property

PUBLIC

Whether this parser produces paths to images on disk for samples that it parses.
fiftyone.utils.data.parsers.ImageSampleParser.has_image_metadata

fiftyone.utils.data.parsers.ImageSampleParser.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.ImageMetadata instances for samples that it parses.
fiftyone.utils.data.parsers.ImageSampleParser.get_image

fiftyone.utils.data.parsers.ImageSampleParser.html#get_image

Function

Method

PUBLIC

Returns the image from the current sample.
fiftyone.utils.data.parsers.ImageSampleParser.get_image_path

fiftyone.utils.data.parsers.ImageSampleParser.html#get_image_path

Function

Method

PUBLIC

Returns the image path for the current sample.
fiftyone.utils.data.parsers.VideoSampleParser

fiftyone.utils.data.parsers.VideoSampleParser.html

Class

Class

PUBLIC

Sample parser that parses unlabeled video samples.
fiftyone.utils.data.parsers.VideoSampleParser.has_video_metadata

fiftyone.utils.data.parsers.VideoSampleParser.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.VideoMetadata instances for samples that it parses.
fiftyone.utils.data.parsers.VideoSampleParser.get_video_path

fiftyone.utils.data.parsers.VideoSampleParser.html#get_video_path

Function

Method

PUBLIC

Returns the video path for the current sample.
fiftyone.utils.data.parsers.MediaSampleParser

fiftyone.utils.data.parsers.MediaSampleParser.html

Class

Class

PUBLIC

Sample parser that parses unlabeled media samples.
fiftyone.utils.data.parsers.MediaSampleParser.has_metadata

fiftyone.utils.data.parsers.MediaSampleParser.html#has_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.Metadata instances for samples that it parses.
fiftyone.utils.data.parsers.MediaSampleParser.get_media_path

fiftyone.utils.data.parsers.MediaSampleParser.html#get_media_path

Function

Method

PUBLIC

Returns the media path for the current sample.
fiftyone.utils.data.parsers.LabeledImageSampleParser

fiftyone.utils.data.parsers.LabeledImageSampleParser.html

Class

Class

PUBLIC

Interface for SampleParser instances that parse labeled image samples.
fiftyone.utils.data.parsers.LabeledImageSampleParser.has_image_path

fiftyone.utils.data.parsers.LabeledImageSampleParser.html#has_image_path

Attribute

Property

PUBLIC

Whether this parser produces paths to images on disk for samples that it parses.
fiftyone.utils.data.parsers.LabeledImageSampleParser.has_image_metadata

fiftyone.utils.data.parsers.LabeledImageSampleParser.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.ImageMetadata instances for samples that it parses.
fiftyone.utils.data.parsers.LabeledImageSampleParser.label_cls

fiftyone.utils.data.parsers.LabeledImageSampleParser.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser.
fiftyone.utils.data.parsers.LabeledImageSampleParser.get_image

fiftyone.utils.data.parsers.LabeledImageSampleParser.html#get_image

Function

Method

PUBLIC

Returns the image from the current sample.
fiftyone.utils.data.parsers.LabeledImageSampleParser.get_image_path

fiftyone.utils.data.parsers.LabeledImageSampleParser.html#get_image_path

Function

Method

PUBLIC

Returns the image path for the current sample.
fiftyone.utils.data.parsers.LabeledImageSampleParser.get_image_metadata

fiftyone.utils.data.parsers.LabeledImageSampleParser.html#get_image_metadata

Function

Method

PUBLIC

Returns the image metadata for the current sample.
fiftyone.utils.data.parsers.LabeledImageSampleParser.get_label

fiftyone.utils.data.parsers.LabeledImageSampleParser.html#get_label

Function

Method

PUBLIC

Returns the label for the current sample.
fiftyone.utils.data.parsers.LabeledVideoSampleParser

fiftyone.utils.data.parsers.LabeledVideoSampleParser.html

Class

Class

PUBLIC

Interface for SampleParser instances that parse labeled video samples.
fiftyone.utils.data.parsers.LabeledVideoSampleParser.has_video_metadata

fiftyone.utils.data.parsers.LabeledVideoSampleParser.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.VideoMetadata instances for samples that it parses.
fiftyone.utils.data.parsers.LabeledVideoSampleParser.label_cls

fiftyone.utils.data.parsers.LabeledVideoSampleParser.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser within the sample-level labels that it produces.
fiftyone.utils.data.parsers.LabeledVideoSampleParser.frame_labels_cls

fiftyone.utils.data.parsers.LabeledVideoSampleParser.html#frame_labels_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser within the frame labels that it produces.
fiftyone.utils.data.parsers.LabeledVideoSampleParser.get_video_path

fiftyone.utils.data.parsers.LabeledVideoSampleParser.html#get_video_path

Function

Method

PUBLIC

Returns the video path for the current sample.
fiftyone.utils.data.parsers.LabeledVideoSampleParser.get_video_metadata

fiftyone.utils.data.parsers.LabeledVideoSampleParser.html#get_video_metadata

Function

Method

PUBLIC

Returns the video metadata for the current sample.
fiftyone.utils.data.parsers.LabeledVideoSampleParser.get_label

fiftyone.utils.data.parsers.LabeledVideoSampleParser.html#get_label

Function

Method

PUBLIC

Returns the sample-level labels for the current sample.
fiftyone.utils.data.parsers.LabeledVideoSampleParser.get_frame_labels

fiftyone.utils.data.parsers.LabeledVideoSampleParser.html#get_frame_labels

Function

Method

PUBLIC

Returns the frame labels for the current sample.
fiftyone.utils.data.parsers.LabeledImageTupleSampleParser

fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.html

Class

Class

PUBLIC

Generic sample parser that parses samples that are (image_or_path, label) tuples, where:
fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.__init__

fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.parsers.LabeledImageTupleSampleParser._current_image_cache

fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.html#_current_image_cache

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.has_image_path

fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.html#has_image_path

Attribute

Property

PUBLIC

Whether this parser produces paths to images on disk for samples that it parses.
fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.has_image_metadata

fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.ImageMetadata instances for samples that it parses.
fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.label_cls

fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser.
fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.get_image

fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.html#get_image

Function

Method

PUBLIC

Returns the image from the current sample.
fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.get_image_path

fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.html#get_image_path

Function

Method

PUBLIC

Returns the image path for the current sample.
fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.get_label

fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.html#get_label

Function

Method

PUBLIC

Returns the label for the current sample.
fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.clear_sample

fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.html#clear_sample

Function

Method

PUBLIC

Clears the current sample.
fiftyone.utils.data.parsers.LabeledImageTupleSampleParser._current_image

fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.html#_current_image

Attribute

Property

PRIVATE

Undocumented
fiftyone.utils.data.parsers.LabeledImageTupleSampleParser._get_image

fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.html#_get_image

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.parsers.LabeledImageTupleSampleParser._parse_image

fiftyone.utils.data.parsers.LabeledImageTupleSampleParser.html#_parse_image

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.parsers.ImageClassificationSampleParser

fiftyone.utils.data.parsers.ImageClassificationSampleParser.html

Class

Class

PUBLIC

Generic parser for image classification(s) samples whose labels are represented as fiftyone.core.labels.Classification instances.
fiftyone.utils.data.parsers.ImageClassificationSampleParser.classes

fiftyone.utils.data.parsers.ImageClassificationSampleParser.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ImageClassificationSampleParser.__init__

fiftyone.utils.data.parsers.ImageClassificationSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ImageClassificationSampleParser.label_cls

fiftyone.utils.data.parsers.ImageClassificationSampleParser.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser.
fiftyone.utils.data.parsers.ImageClassificationSampleParser.get_label

fiftyone.utils.data.parsers.ImageClassificationSampleParser.html#get_label

Function

Method

PUBLIC

Returns the label for the current sample.
fiftyone.utils.data.parsers.ImageClassificationSampleParser._parse_label

fiftyone.utils.data.parsers.ImageClassificationSampleParser.html#_parse_label

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.parsers.ImageDetectionSampleParser

fiftyone.utils.data.parsers.ImageDetectionSampleParser.html

Class

Class

PUBLIC

Generic parser for image detection samples whose labels are represented as fiftyone.core.labels.Detections instances.
fiftyone.utils.data.parsers.ImageDetectionSampleParser.label_field

fiftyone.utils.data.parsers.ImageDetectionSampleParser.html#label_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ImageDetectionSampleParser.bounding_box_field

fiftyone.utils.data.parsers.ImageDetectionSampleParser.html#bounding_box_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ImageDetectionSampleParser.confidence_field

fiftyone.utils.data.parsers.ImageDetectionSampleParser.html#confidence_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ImageDetectionSampleParser.attributes_field

fiftyone.utils.data.parsers.ImageDetectionSampleParser.html#attributes_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ImageDetectionSampleParser.classes

fiftyone.utils.data.parsers.ImageDetectionSampleParser.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ImageDetectionSampleParser.normalized

fiftyone.utils.data.parsers.ImageDetectionSampleParser.html#normalized

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ImageDetectionSampleParser.__init__

fiftyone.utils.data.parsers.ImageDetectionSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ImageDetectionSampleParser.label_cls

fiftyone.utils.data.parsers.ImageDetectionSampleParser.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser.
fiftyone.utils.data.parsers.ImageDetectionSampleParser.get_label

fiftyone.utils.data.parsers.ImageDetectionSampleParser.html#get_label

Function

Method

PUBLIC

Returns the label for the current sample.
fiftyone.utils.data.parsers.ImageDetectionSampleParser._parse_label

fiftyone.utils.data.parsers.ImageDetectionSampleParser.html#_parse_label

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.parsers.ImageDetectionSampleParser._parse_detection

fiftyone.utils.data.parsers.ImageDetectionSampleParser.html#_parse_detection

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.parsers.ImageDetectionSampleParser._parse_bbox

fiftyone.utils.data.parsers.ImageDetectionSampleParser.html#_parse_bbox

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.parsers.ImageLabelsSampleParser

fiftyone.utils.data.parsers.ImageLabelsSampleParser.html

Class

Class

PUBLIC

Generic parser for multitask image prediction samples whose labels are stored in eta.core.image.ImageLabels format.
fiftyone.utils.data.parsers.ImageLabelsSampleParser.prefix

fiftyone.utils.data.parsers.ImageLabelsSampleParser.html#prefix

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ImageLabelsSampleParser.labels_dict

fiftyone.utils.data.parsers.ImageLabelsSampleParser.html#labels_dict

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ImageLabelsSampleParser.multilabel

fiftyone.utils.data.parsers.ImageLabelsSampleParser.html#multilabel

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ImageLabelsSampleParser.skip_non_categorical

fiftyone.utils.data.parsers.ImageLabelsSampleParser.html#skip_non_categorical

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ImageLabelsSampleParser.__init__

fiftyone.utils.data.parsers.ImageLabelsSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ImageLabelsSampleParser.label_cls

fiftyone.utils.data.parsers.ImageLabelsSampleParser.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser.
fiftyone.utils.data.parsers.ImageLabelsSampleParser.get_label

fiftyone.utils.data.parsers.ImageLabelsSampleParser.html#get_label

Function

Method

PUBLIC

Returns the label for the current sample.
fiftyone.utils.data.parsers.ImageLabelsSampleParser._parse_label

fiftyone.utils.data.parsers.ImageLabelsSampleParser.html#_parse_label

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.parsers.FiftyOneImageClassificationSampleParser

fiftyone.utils.data.parsers.FiftyOneImageClassificationSampleParser.html

Class

Class

PUBLIC

Parser for samples in FiftyOne image classification datasets.
fiftyone.utils.data.parsers.FiftyOneImageClassificationSampleParser.__init__

fiftyone.utils.data.parsers.FiftyOneImageClassificationSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser

fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.html

Class

Class

PUBLIC

Parser for samples in FiftyOne temporal detection datasets.
fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.classes

fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.compute_metadata

fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.__init__

fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser._current_metadata

fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.html#_current_metadata

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.has_video_metadata

fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.VideoMetadata instances for samples that it parses.
fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.label_cls

fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser within the sample-level labels that it produces.
fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.frame_labels_cls

fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.html#frame_labels_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser within the frame labels that it produces.
fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.with_sample

fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.html#with_sample

Function

Method

PUBLIC

Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample.
fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.get_video_path

fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.html#get_video_path

Function

Method

PUBLIC

Returns the video path for the current sample.
fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.get_video_metadata

fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.html#get_video_metadata

Function

Method

PUBLIC

Returns the video metadata for the current sample.
fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.get_label

fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.html#get_label

Function

Method

PUBLIC

Returns the sample-level labels for the current sample.
fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.get_frame_labels

fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.html#get_frame_labels

Function

Method

PUBLIC

Returns the frame labels for the current sample.
fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.clear_sample

fiftyone.utils.data.parsers.FiftyOneTemporalDetectionSampleParser.html#clear_sample

Function

Method

PUBLIC

Clears the current sample.
fiftyone.utils.data.parsers.FiftyOneImageDetectionSampleParser

fiftyone.utils.data.parsers.FiftyOneImageDetectionSampleParser.html

Class

Class

PUBLIC

Parser for samples in FiftyOne image detection datasets.
fiftyone.utils.data.parsers.FiftyOneImageDetectionSampleParser.__init__

fiftyone.utils.data.parsers.FiftyOneImageDetectionSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneImageLabelsSampleParser

fiftyone.utils.data.parsers.FiftyOneImageLabelsSampleParser.html

Class

Class

PUBLIC

Parser for samples in FiftyOne image labels datasets.
fiftyone.utils.data.parsers.VideoLabelsSampleParser

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html

Class

Class

PUBLIC

Generic parser for labeled video samples whose labels are represented in eta.core.video.VideoLabels format.
fiftyone.utils.data.parsers.VideoLabelsSampleParser.prefix

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html#prefix

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.VideoLabelsSampleParser.labels_dict

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html#labels_dict

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.VideoLabelsSampleParser.frame_labels_dict

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html#frame_labels_dict

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.VideoLabelsSampleParser.multilabel

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html#multilabel

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.VideoLabelsSampleParser.skip_non_categorical

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html#skip_non_categorical

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.VideoLabelsSampleParser.__init__

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.parsers.VideoLabelsSampleParser._curr_label

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html#_curr_label

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.parsers.VideoLabelsSampleParser._curr_frames

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html#_curr_frames

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.parsers.VideoLabelsSampleParser.has_video_metadata

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.VideoMetadata instances for samples that it parses.
fiftyone.utils.data.parsers.VideoLabelsSampleParser.label_cls

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser within the sample-level labels that it produces.
fiftyone.utils.data.parsers.VideoLabelsSampleParser.frame_labels_cls

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html#frame_labels_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser within the frame labels that it produces.
fiftyone.utils.data.parsers.VideoLabelsSampleParser.get_video_path

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html#get_video_path

Function

Method

PUBLIC

Returns the video path for the current sample.
fiftyone.utils.data.parsers.VideoLabelsSampleParser.get_label

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html#get_label

Function

Method

PUBLIC

Returns the sample-level labels for the current sample.
fiftyone.utils.data.parsers.VideoLabelsSampleParser.get_frame_labels

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html#get_frame_labels

Function

Method

PUBLIC

Returns the frame labels for the current sample.
fiftyone.utils.data.parsers.VideoLabelsSampleParser.clear_sample

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html#clear_sample

Function

Method

PUBLIC

Clears the current sample.
fiftyone.utils.data.parsers.VideoLabelsSampleParser._parse_labels

fiftyone.utils.data.parsers.VideoLabelsSampleParser.html#_parse_labels

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.parsers.FiftyOneVideoLabelsSampleParser

fiftyone.utils.data.parsers.FiftyOneVideoLabelsSampleParser.html

Class

Class

PUBLIC

Parser for samples in FiftyOne video labels datasets.
fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser

fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.html

Class

Class

PUBLIC

Parser for fiftyone.core.sample.Sample instances that contain images.
fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.compute_metadata

fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.__init__

fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.has_image_path

fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.html#has_image_path

Attribute

Property

PUBLIC

Whether this parser produces paths to images on disk for samples that it parses.
fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.has_image_metadata

fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.ImageMetadata instances for samples that it parses.
fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.get_image

fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.html#get_image

Function

Method

PUBLIC

Returns the image from the current sample.
fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.get_image_path

fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.html#get_image_path

Function

Method

PUBLIC

Returns the image path for the current sample.
fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.get_image_metadata

fiftyone.utils.data.parsers.FiftyOneUnlabeledImageSampleParser.html#get_image_metadata

Function

Method

PUBLIC

Returns the image metadata for the current sample.
fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser

fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.html

Class

Class

PUBLIC

Parser for fiftyone.core.sample.Sample instances that contain labeled images.
fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.label_fcn

fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.html#label_fcn

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.compute_metadata

fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.__init__

fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.label_field

fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.html#label_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.has_image_path

fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.html#has_image_path

Attribute

Property

PUBLIC

Whether this parser produces paths to images on disk for samples that it parses.
fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.has_image_metadata

fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.ImageMetadata instances for samples that it parses.
fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.label_cls

fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser.
fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.get_image

fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.html#get_image

Function

Method

PUBLIC

Returns the image from the current sample.
fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.get_image_path

fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.html#get_image_path

Function

Method

PUBLIC

Returns the image path for the current sample.
fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.get_image_metadata

fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.html#get_image_metadata

Function

Method

PUBLIC

Returns the image metadata for the current sample.
fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.get_label

fiftyone.utils.data.parsers.FiftyOneLabeledImageSampleParser.html#get_label

Function

Method

PUBLIC

Returns the label for the current sample.
fiftyone.utils.data.parsers.ExtractClipsMixin

fiftyone.utils.data.parsers.ExtractClipsMixin.html

Class

Class

PUBLIC

Mixin for sample parsers that extract clips from fiftyone.core.clips.ClipView instances.
fiftyone.utils.data.parsers.ExtractClipsMixin.compute_metadata

fiftyone.utils.data.parsers.ExtractClipsMixin.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ExtractClipsMixin.write_clips

fiftyone.utils.data.parsers.ExtractClipsMixin.html#write_clips

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ExtractClipsMixin.clip_dir

fiftyone.utils.data.parsers.ExtractClipsMixin.html#clip_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ExtractClipsMixin.video_format

fiftyone.utils.data.parsers.ExtractClipsMixin.html#video_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ExtractClipsMixin.__init__

fiftyone.utils.data.parsers.ExtractClipsMixin.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.parsers.ExtractClipsMixin._curr_clip_path

fiftyone.utils.data.parsers.ExtractClipsMixin.html#_curr_clip_path

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.parsers.ExtractClipsMixin._get_clip_path

fiftyone.utils.data.parsers.ExtractClipsMixin.html#_get_clip_path

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.parsers.ExtractClipsMixin._get_clip_metadata

fiftyone.utils.data.parsers.ExtractClipsMixin.html#_get_clip_metadata

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser

fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser.html

Class

Class

PUBLIC

Parser for fiftyone.core.sample.Sample instances that contain videos.
fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser.__init__

fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser.has_video_metadata

fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.VideoMetadata instances for samples that it parses.
fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser.get_video_path

fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser.html#get_video_path

Function

Method

PUBLIC

Returns the video path for the current sample.
fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser.get_video_metadata

fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser.html#get_video_metadata

Function

Method

PUBLIC

Returns the video metadata for the current sample.
fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser

fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.html

Class

Class

PUBLIC

Parser for fiftyone.core.sample.Sample instances that contain labeled videos.
fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.label_field

fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.html#label_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.label_fcn

fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.html#label_fcn

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.__init__

fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.frame_labels_dict

fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.html#frame_labels_dict

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.frame_fcn_dict

fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.html#frame_fcn_dict

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.has_video_metadata

fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.VideoMetadata instances for samples that it parses.
fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.label_cls

fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser within the sample-level labels that it produces.
fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.frame_labels_cls

fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.html#frame_labels_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser within the frame labels that it produces.
fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.get_video_path

fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.html#get_video_path

Function

Method

PUBLIC

Returns the video path for the current sample.
fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.get_video_metadata

fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.html#get_video_metadata

Function

Method

PUBLIC

Returns the video metadata for the current sample.
fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.get_label

fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.html#get_label

Function

Method

PUBLIC

Returns the sample-level labels for the current sample.
fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.get_frame_labels

fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.html#get_frame_labels

Function

Method

PUBLIC

Returns the frame labels for the current sample.
fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser._parse_frame_args

fiftyone.utils.data.parsers.FiftyOneLabeledVideoSampleParser.html#_parse_frame_args

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser

fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.html

Class

Class

PUBLIC

Parser for fiftyone.core.sample.Sample instances that contain unlabeled media.
fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.compute_metadata

fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.__init__

fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.has_metadata

fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.html#has_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.Metadata instances for samples that it parses.
fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.get_media_path

fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.html#get_media_path

Function

Method

PUBLIC

Returns the media path for the current sample.
fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.get_metadata

fiftyone.utils.data.parsers.FiftyOneUnlabeledMediaSampleParser.html#get_metadata

Function

Method

PUBLIC

Returns the metadata for the current sample.
fiftyone.utils.data.exporters.logger

fiftyone.utils.data.exporters.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.export_samples

fiftyone.utils.data.exporters.html#export_samples

Function

Function

PUBLIC

Exports the given samples to disk.
fiftyone.utils.data.exporters.write_dataset

fiftyone.utils.data.exporters.html#write_dataset

Function

Function

PUBLIC

Writes the samples to disk as a dataset in the specified format.
fiftyone.utils.data.exporters.build_dataset_exporter

fiftyone.utils.data.exporters.html#build_dataset_exporter

Function

Function

PUBLIC

Builds the DatasetExporter instance for the given parameters.
fiftyone.utils.data.exporters._check_for_patches_export

fiftyone.utils.data.exporters.html#_check_for_patches_export

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._check_for_clips_export

fiftyone.utils.data.exporters.html#_check_for_clips_export

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._make_label_coercion_functions

fiftyone.utils.data.exporters.html#_make_label_coercion_functions

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._make_single_label_to_list_fcn

fiftyone.utils.data.exporters.html#_make_single_label_to_list_fcn

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._classification_to_detections

fiftyone.utils.data.exporters.html#_classification_to_detections

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._write_batch_dataset

fiftyone.utils.data.exporters.html#_write_batch_dataset

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._write_generic_sample_dataset

fiftyone.utils.data.exporters.html#_write_generic_sample_dataset

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._write_group_dataset

fiftyone.utils.data.exporters.html#_write_group_dataset

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._write_image_dataset

fiftyone.utils.data.exporters.html#_write_image_dataset

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._write_video_dataset

fiftyone.utils.data.exporters.html#_write_video_dataset

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._write_unlabeled_dataset

fiftyone.utils.data.exporters.html#_write_unlabeled_dataset

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters.ExportPathsMixin

fiftyone.utils.data.exporters.ExportPathsMixin.html

Class

Class

PUBLIC

Mixin for DatasetExporter classes that provides convenience methods for parsing the data_path, labels_path, and export_media parameters supported by many exporters.
fiftyone.utils.data.exporters.ExportPathsMixin._parse_data_path

fiftyone.utils.data.exporters.ExportPathsMixin.html#_parse_data_path

Function

Static Method

PRIVATE

Helper function that computes default values for the data_path and export_media parameters supported by many exporters.
fiftyone.utils.data.exporters.ExportPathsMixin._parse_labels_path

fiftyone.utils.data.exporters.ExportPathsMixin.html#_parse_labels_path

Function

Static Method

PRIVATE

Helper function that computes default values for the labels_path parameter supported by many exporters.
fiftyone.utils.data.exporters.MediaExporter

fiftyone.utils.data.exporters.MediaExporter.html

Class

Class

PUBLIC

Base class for DatasetExporter utilities that provide support for populating a directory or manifest of media files.
fiftyone.utils.data.exporters.MediaExporter.export_path

fiftyone.utils.data.exporters.MediaExporter.html#export_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.MediaExporter.rel_dir

fiftyone.utils.data.exporters.MediaExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.MediaExporter.chunk_size

fiftyone.utils.data.exporters.MediaExporter.html#chunk_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.MediaExporter.supported_modes

fiftyone.utils.data.exporters.MediaExporter.html#supported_modes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.MediaExporter.default_ext

fiftyone.utils.data.exporters.MediaExporter.html#default_ext

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.MediaExporter.ignore_exts

fiftyone.utils.data.exporters.MediaExporter.html#ignore_exts

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.MediaExporter.__init__

fiftyone.utils.data.exporters.MediaExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.MediaExporter.export_mode

fiftyone.utils.data.exporters.MediaExporter.html#export_mode

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.MediaExporter._filename_maker

fiftyone.utils.data.exporters.MediaExporter.html#_filename_maker

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.MediaExporter._manifest

fiftyone.utils.data.exporters.MediaExporter.html#_manifest

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.MediaExporter._manifest_path

fiftyone.utils.data.exporters.MediaExporter.html#_manifest_path

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.MediaExporter._handle_fo3d_file

fiftyone.utils.data.exporters.MediaExporter.html#_handle_fo3d_file

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.exporters.MediaExporter.__enter__

fiftyone.utils.data.exporters.MediaExporter.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.MediaExporter.__exit__

fiftyone.utils.data.exporters.MediaExporter.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.MediaExporter._write_media

fiftyone.utils.data.exporters.MediaExporter.html#_write_media

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.exporters.MediaExporter._get_uuid

fiftyone.utils.data.exporters.MediaExporter.html#_get_uuid

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.exporters.MediaExporter.setup

fiftyone.utils.data.exporters.MediaExporter.html#setup

Function

Method

PUBLIC

Performs necessary setup to begin exporting media.
fiftyone.utils.data.exporters.MediaExporter.export

fiftyone.utils.data.exporters.MediaExporter.html#export

Function

Method

PUBLIC

Exports the given media.
fiftyone.utils.data.exporters.MediaExporter.close

fiftyone.utils.data.exporters.MediaExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions to complete the export.
fiftyone.utils.data.exporters.ImageExporter

fiftyone.utils.data.exporters.ImageExporter.html

Class

Class

PUBLIC

Utility class for DatasetExporter instances that export images.
fiftyone.utils.data.exporters.ImageExporter.__init__

fiftyone.utils.data.exporters.ImageExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageExporter._write_media

fiftyone.utils.data.exporters.ImageExporter.html#_write_media

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.exporters.VideoExporter

fiftyone.utils.data.exporters.VideoExporter.html

Class

Class

PUBLIC

Utility class for DatasetExporter instances that export videos.
fiftyone.utils.data.exporters.VideoExporter.__init__

fiftyone.utils.data.exporters.VideoExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.VideoExporter._write_media

fiftyone.utils.data.exporters.VideoExporter.html#_write_media

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.exporters.DatasetExporter

fiftyone.utils.data.exporters.DatasetExporter.html

Class

Class

PUBLIC

Base interface for exporting datasets.
fiftyone.utils.data.exporters.DatasetExporter.export_dir

fiftyone.utils.data.exporters.DatasetExporter.html#export_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.DatasetExporter.__init__

fiftyone.utils.data.exporters.DatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.DatasetExporter.__enter__

fiftyone.utils.data.exporters.DatasetExporter.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.DatasetExporter.__exit__

fiftyone.utils.data.exporters.DatasetExporter.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.DatasetExporter.setup

fiftyone.utils.data.exporters.DatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.data.exporters.DatasetExporter.log_collection

fiftyone.utils.data.exporters.DatasetExporter.html#log_collection

Function

Method

PUBLIC

Logs any relevant information about the fiftyone.core.collections.SampleCollection whose samples will be exported.
fiftyone.utils.data.exporters.DatasetExporter.export_sample

fiftyone.utils.data.exporters.DatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.DatasetExporter.close

fiftyone.utils.data.exporters.DatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.data.exporters.BatchDatasetExporter

fiftyone.utils.data.exporters.BatchDatasetExporter.html

Class

Class

PUBLIC

Base interface for exporters that export entire fiftyone.core.collections.SampleCollection instances in a single batch.
fiftyone.utils.data.exporters.BatchDatasetExporter.export_sample

fiftyone.utils.data.exporters.BatchDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.BatchDatasetExporter.export_samples

fiftyone.utils.data.exporters.BatchDatasetExporter.html#export_samples

Function

Method

PUBLIC

Exports the given sample collection.
fiftyone.utils.data.exporters.GenericSampleDatasetExporter

fiftyone.utils.data.exporters.GenericSampleDatasetExporter.html

Class

Class

PUBLIC

Interface for exporting datasets of arbitrary fiftyone.core.sample.Sample instances.
fiftyone.utils.data.exporters.GenericSampleDatasetExporter.export_sample

fiftyone.utils.data.exporters.GenericSampleDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.GroupDatasetExporter

fiftyone.utils.data.exporters.GroupDatasetExporter.html

Class

Class

PUBLIC

Interface for exporting grouped datasets.
fiftyone.utils.data.exporters.GroupDatasetExporter.export_sample

fiftyone.utils.data.exporters.GroupDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.GroupDatasetExporter.export_group

fiftyone.utils.data.exporters.GroupDatasetExporter.html#export_group

Function

Method

PUBLIC

Exports the given group to the dataset.
fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter

fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter.html

Class

Class

PUBLIC

Interface for exporting datasets of unlabeled image samples.
fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter.requires_image_metadata

fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter.html#requires_image_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.
fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter.export_sample

fiftyone.utils.data.exporters.UnlabeledImageDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.UnlabeledVideoDatasetExporter

fiftyone.utils.data.exporters.UnlabeledVideoDatasetExporter.html

Class

Class

PUBLIC

Interface for exporting datasets of unlabeled video samples.
fiftyone.utils.data.exporters.UnlabeledVideoDatasetExporter.requires_video_metadata

fiftyone.utils.data.exporters.UnlabeledVideoDatasetExporter.html#requires_video_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.VideoMetadata instances for each sample being exported.
fiftyone.utils.data.exporters.UnlabeledVideoDatasetExporter.export_sample

fiftyone.utils.data.exporters.UnlabeledVideoDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.UnlabeledMediaDatasetExporter

fiftyone.utils.data.exporters.UnlabeledMediaDatasetExporter.html

Class

Class

PUBLIC

Interface for exporting datasets of unlabeled samples.
fiftyone.utils.data.exporters.UnlabeledMediaDatasetExporter.requires_metadata

fiftyone.utils.data.exporters.UnlabeledMediaDatasetExporter.html#requires_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.Metadata instances for each sample being exported.
fiftyone.utils.data.exporters.UnlabeledMediaDatasetExporter.export_sample

fiftyone.utils.data.exporters.UnlabeledMediaDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.LabeledImageDatasetExporter

fiftyone.utils.data.exporters.LabeledImageDatasetExporter.html

Class

Class

PUBLIC

Interface for exporting datasets of labeled image samples.
fiftyone.utils.data.exporters.LabeledImageDatasetExporter.requires_image_metadata

fiftyone.utils.data.exporters.LabeledImageDatasetExporter.html#requires_image_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.
fiftyone.utils.data.exporters.LabeledImageDatasetExporter.label_cls

fiftyone.utils.data.exporters.LabeledImageDatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) exported by this exporter.
fiftyone.utils.data.exporters.LabeledImageDatasetExporter.export_sample

fiftyone.utils.data.exporters.LabeledImageDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.LabeledVideoDatasetExporter

fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.html

Class

Class

PUBLIC

Interface for exporting datasets of labeled video samples.
fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.requires_video_metadata

fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.html#requires_video_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.VideoMetadata instances for each sample being exported.
fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.label_cls

fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) that can be exported at the sample-level.
fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.frame_labels_cls

fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.html#frame_labels_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) that can be exported by this exporter at the frame-level.
fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.export_sample

fiftyone.utils.data.exporters.LabeledVideoDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html

Class

Class

PUBLIC

Legacy exporter that writes an entire FiftyOne dataset to disk in a serialized JSON format along with its source media.
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.export_media

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.rel_dir

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.chunk_size

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#chunk_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.abs_paths

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#abs_paths

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.export_saved_views

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#export_saved_views

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.export_runs

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#export_runs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.export_workspaces

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#export_workspaces

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.pretty_print

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#pretty_print

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.__init__

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._data_dir

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_data_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._fields_dir

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_fields_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._anno_dir

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_anno_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._brain_dir

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_brain_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._eval_dir

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_eval_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._runs_dir

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_runs_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._frame_labels_dir

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_frame_labels_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._metadata_path

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_metadata_path

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._samples_path

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_samples_path

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._metadata

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_metadata

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._samples

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._media_exporter

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._media_fields

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_media_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._media_field_exporters

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_media_field_exporters

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.setup

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.log_collection

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#log_collection

Function

Method

PUBLIC

Logs any relevant information about the fiftyone.core.collections.SampleCollection whose samples will be exported.
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.export_sample

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.close

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._export_frame_labels

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_export_frame_labels

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._export_media_fields

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_export_media_fields

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._export_media_field

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_export_media_field

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter._get_media_field_exporter

fiftyone.utils.data.exporters.LegacyFiftyOneDatasetExporter.html#_get_media_field_exporter

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html

Class

Class

PUBLIC

Exporter that writes an entire FiftyOne dataset to disk in a serialized JSON format along with its source media.
fiftyone.utils.data.exporters.FiftyOneDatasetExporter.export_media

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter.rel_dir

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter.chunk_size

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#chunk_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter.export_saved_views

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#export_saved_views

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter.export_runs

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#export_runs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter.export_workspaces

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#export_workspaces

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter.use_dirs

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#use_dirs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter.ordered

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#ordered

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter.__init__

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter._data_dir

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#_data_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter._fields_dir

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#_fields_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter._anno_dir

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#_anno_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter._brain_dir

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#_brain_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter._eval_dir

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#_eval_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter._runs_dir

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#_runs_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter._metadata_path

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#_metadata_path

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter._samples_path

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#_samples_path

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter._frames_path

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#_frames_path

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter._media_exporter

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter._media_fields

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#_media_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter._media_field_exporters

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#_media_field_exporters

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter.setup

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.data.exporters.FiftyOneDatasetExporter.export_samples

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#export_samples

Function

Method

PUBLIC

Exports the given sample collection.
fiftyone.utils.data.exporters.FiftyOneDatasetExporter._export_media_fields

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#_export_media_fields

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter._export_media_field

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#_export_media_field

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneDatasetExporter._get_media_field_exporter

fiftyone.utils.data.exporters.FiftyOneDatasetExporter.html#_get_media_field_exporter

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.exporters._export_annotation_results

fiftyone.utils.data.exporters.html#_export_annotation_results

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._export_brain_results

fiftyone.utils.data.exporters.html#_export_brain_results

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._export_evaluation_results

fiftyone.utils.data.exporters.html#_export_evaluation_results

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._export_run_results

fiftyone.utils.data.exporters.html#_export_run_results

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters.ImageDirectoryExporter

fiftyone.utils.data.exporters.ImageDirectoryExporter.html

Class

Class

PUBLIC

Exporter that writes a directory of images to disk.
fiftyone.utils.data.exporters.ImageDirectoryExporter.export_media

fiftyone.utils.data.exporters.ImageDirectoryExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageDirectoryExporter.rel_dir

fiftyone.utils.data.exporters.ImageDirectoryExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageDirectoryExporter.image_format

fiftyone.utils.data.exporters.ImageDirectoryExporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageDirectoryExporter.__init__

fiftyone.utils.data.exporters.ImageDirectoryExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageDirectoryExporter._media_exporter

fiftyone.utils.data.exporters.ImageDirectoryExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.ImageDirectoryExporter.requires_image_metadata

fiftyone.utils.data.exporters.ImageDirectoryExporter.html#requires_image_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.
fiftyone.utils.data.exporters.ImageDirectoryExporter.setup

fiftyone.utils.data.exporters.ImageDirectoryExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.data.exporters.ImageDirectoryExporter.export_sample

fiftyone.utils.data.exporters.ImageDirectoryExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.ImageDirectoryExporter.close

fiftyone.utils.data.exporters.ImageDirectoryExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.data.exporters.VideoDirectoryExporter

fiftyone.utils.data.exporters.VideoDirectoryExporter.html

Class

Class

PUBLIC

Exporter that writes a directory of videos to disk.
fiftyone.utils.data.exporters.VideoDirectoryExporter.export_media

fiftyone.utils.data.exporters.VideoDirectoryExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.VideoDirectoryExporter.rel_dir

fiftyone.utils.data.exporters.VideoDirectoryExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.VideoDirectoryExporter.__init__

fiftyone.utils.data.exporters.VideoDirectoryExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.VideoDirectoryExporter._media_exporter

fiftyone.utils.data.exporters.VideoDirectoryExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.VideoDirectoryExporter.requires_video_metadata

fiftyone.utils.data.exporters.VideoDirectoryExporter.html#requires_video_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.VideoMetadata instances for each sample being exported.
fiftyone.utils.data.exporters.VideoDirectoryExporter.setup

fiftyone.utils.data.exporters.VideoDirectoryExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.data.exporters.VideoDirectoryExporter.export_sample

fiftyone.utils.data.exporters.VideoDirectoryExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.VideoDirectoryExporter.close

fiftyone.utils.data.exporters.VideoDirectoryExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.data.exporters.MediaDirectoryExporter

fiftyone.utils.data.exporters.MediaDirectoryExporter.html

Class

Class

PUBLIC

Exporter that writes a directory of media files of arbitrary type to disk.
fiftyone.utils.data.exporters.MediaDirectoryExporter.export_media

fiftyone.utils.data.exporters.MediaDirectoryExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.MediaDirectoryExporter.rel_dir

fiftyone.utils.data.exporters.MediaDirectoryExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.MediaDirectoryExporter.__init__

fiftyone.utils.data.exporters.MediaDirectoryExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.MediaDirectoryExporter._media_exporter

fiftyone.utils.data.exporters.MediaDirectoryExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.MediaDirectoryExporter.requires_metadata

fiftyone.utils.data.exporters.MediaDirectoryExporter.html#requires_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.Metadata instances for each sample being exported.
fiftyone.utils.data.exporters.MediaDirectoryExporter.setup

fiftyone.utils.data.exporters.MediaDirectoryExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.data.exporters.MediaDirectoryExporter.export_sample

fiftyone.utils.data.exporters.MediaDirectoryExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.MediaDirectoryExporter.close

fiftyone.utils.data.exporters.MediaDirectoryExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html

Class

Class

PUBLIC

Exporter that writes an image classification dataset to disk in a simple JSON format.
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.data_path

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.labels_path

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.export_media

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.rel_dir

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.abs_paths

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#abs_paths

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.include_confidence

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#include_confidence

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.include_attributes

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#include_attributes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.classes

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.image_format

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.pretty_print

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#pretty_print

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.__init__

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter._labels_dict

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#_labels_dict

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter._labels_map_rev

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#_labels_map_rev

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter._media_exporter

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.requires_image_metadata

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#requires_image_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.label_cls

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) exported by this exporter.
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.setup

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.export_sample

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.close

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter._parse_classes

fiftyone.utils.data.exporters.FiftyOneImageClassificationDatasetExporter.html#_parse_classes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter

fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.html

Class

Class

PUBLIC

Exporter that writes an image classification directory tree to disk.
fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.export_media

fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.rel_dir

fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.image_format

fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.__init__

fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter._class_counts

fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.html#_class_counts

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter._filename_counts

fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.html#_filename_counts

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter._media_exporter

fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter._default_filename_patt

fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.html#_default_filename_patt

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.requires_image_metadata

fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.html#requires_image_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.
fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.label_cls

fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) exported by this exporter.
fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.setup

fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.export_sample

fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.close

fiftyone.utils.data.exporters.ImageClassificationDirectoryTreeExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter

fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.html

Class

Class

PUBLIC

Exporter that writes a video classification directory tree to disk.
fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.export_media

fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.rel_dir

fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.__init__

fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter._class_counts

fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.html#_class_counts

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter._filename_counts

fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.html#_filename_counts

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter._media_exporter

fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.requires_video_metadata

fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.html#requires_video_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.VideoMetadata instances for each sample being exported.
fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.label_cls

fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) that can be exported at the sample-level.
fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.frame_labels_cls

fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.html#frame_labels_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) that can be exported by this exporter at the frame-level.
fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.setup

fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.export_sample

fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.close

fiftyone.utils.data.exporters.VideoClassificationDirectoryTreeExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html

Class

Class

PUBLIC

Exporter that writes an image detection dataset to disk in a simple JSON format.
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.data_path

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.labels_path

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.export_media

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.rel_dir

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.abs_paths

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#abs_paths

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.classes

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.include_confidence

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#include_confidence

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.include_attributes

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#include_attributes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.image_format

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.pretty_print

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#pretty_print

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.__init__

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter._labels_dict

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#_labels_dict

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter._labels_map_rev

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#_labels_map_rev

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter._media_exporter

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.requires_image_metadata

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#requires_image_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.label_cls

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) exported by this exporter.
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.setup

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.export_sample

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.close

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter._parse_classes

fiftyone.utils.data.exporters.FiftyOneImageDetectionDatasetExporter.html#_parse_classes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html

Class

Class

PUBLIC

Exporter that writes a temporal video detection dataset to disk in a simple JSON format.
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.data_path

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.labels_path

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.export_media

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.rel_dir

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.abs_paths

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#abs_paths

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.use_timestamps

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#use_timestamps

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.classes

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.include_confidence

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#include_confidence

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.include_attributes

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#include_attributes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.pretty_print

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#pretty_print

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.__init__

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter._labels_dict

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#_labels_dict

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter._labels_map_rev

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#_labels_map_rev

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter._media_exporter

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.requires_video_metadata

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#requires_video_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.VideoMetadata instances for each sample being exported.
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.label_cls

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) that can be exported at the sample-level.
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.frame_labels_cls

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#frame_labels_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) that can be exported by this exporter at the frame-level.
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.setup

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.export_sample

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.close

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter._parse_classes

fiftyone.utils.data.exporters.FiftyOneTemporalDetectionDatasetExporter.html#_parse_classes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html

Class

Class

PUBLIC

Exporter that writes an image segmentation dataset to disk.
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.data_path

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.labels_path

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.export_media

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.rel_dir

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.image_format

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.mask_format

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html#mask_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.mask_size

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html#mask_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.mask_targets

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html#mask_targets

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.thickness

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html#thickness

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.__init__

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter._media_exporter

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.requires_image_metadata

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html#requires_image_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.label_cls

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) exported by this exporter.
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.setup

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.export_sample

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.close

fiftyone.utils.data.exporters.ImageSegmentationDirectoryExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html

Class

Class

PUBLIC

Exporter that writes a labeled image dataset to disk with labels stored in ETA ImageLabels format.
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.export_media

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.rel_dir

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.image_format

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.pretty_print

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#pretty_print

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.__init__

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter._dataset_index

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#_dataset_index

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter._manifest_path

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#_manifest_path

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter._data_dir

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#_data_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter._labels_dir

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#_labels_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter._description

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter._media_exporter

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.requires_image_metadata

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#requires_image_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.label_cls

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) exported by this exporter.
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.setup

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.log_collection

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#log_collection

Function

Method

PUBLIC

Logs any relevant information about the fiftyone.core.collections.SampleCollection whose samples will be exported.
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.export_sample

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.close

fiftyone.utils.data.exporters.FiftyOneImageLabelsDatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html

Class

Class

PUBLIC

Exporter that writes a labeled video dataset with labels stored in ETA VideoLabels format.
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.export_media

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.rel_dir

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.pretty_print

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#pretty_print

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.__init__

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter._dataset_index

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#_dataset_index

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter._manifest_path

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#_manifest_path

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter._data_dir

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#_data_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter._labels_dir

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#_labels_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter._description

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter._media_exporter

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.requires_video_metadata

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#requires_video_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.VideoMetadata instances for each sample being exported.
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.label_cls

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) that can be exported at the sample-level.
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.frame_labels_cls

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#frame_labels_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) that can be exported by this exporter at the frame-level.
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.setup

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.log_collection

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#log_collection

Function

Method

PUBLIC

Logs any relevant information about the fiftyone.core.collections.SampleCollection whose samples will be exported.
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.export_sample

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.close

fiftyone.utils.data.exporters.FiftyOneVideoLabelsDatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.data.exporters._parse_classifications

fiftyone.utils.data.exporters.html#_parse_classifications

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._parse_temporal_detections

fiftyone.utils.data.exporters.html#_parse_temporal_detections

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._parse_detections

fiftyone.utils.data.exporters.html#_parse_detections

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._parse_attributes

fiftyone.utils.data.exporters.html#_parse_attributes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.exporters._to_labels_map_rev

fiftyone.utils.data.exporters.html#_to_labels_map_rev

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.importers.logger

fiftyone.utils.data.importers.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.import_samples

fiftyone.utils.data.importers.html#import_samples

Function

Function

PUBLIC

Adds the samples from the given DatasetImporter to the dataset.
fiftyone.utils.data.importers.merge_samples

fiftyone.utils.data.importers.html#merge_samples

Function

Function

PUBLIC

Merges the samples from the given DatasetImporter into the dataset.
fiftyone.utils.data.importers._handle_legacy_formats

fiftyone.utils.data.importers.html#_handle_legacy_formats

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.importers._generate_group_samples

fiftyone.utils.data.importers.html#_generate_group_samples

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.importers._build_parse_sample_fcn

fiftyone.utils.data.importers.html#_build_parse_sample_fcn

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.importers.build_dataset_importer

fiftyone.utils.data.importers.html#build_dataset_importer

Function

Function

PUBLIC

Builds the DatasetImporter instance for the given parameters.
fiftyone.utils.data.importers.parse_dataset_info

fiftyone.utils.data.importers.html#parse_dataset_info

Function

Function

PUBLIC

Parses the info returned by DatasetImporter.get_dataset_info and stores it on the relevant properties of the dataset.
fiftyone.utils.data.importers._update_no_overwrite

fiftyone.utils.data.importers.html#_update_no_overwrite

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImportPathsMixin

fiftyone.utils.data.importers.ImportPathsMixin.html

Class

Class

PUBLIC

Mixin for DatasetImporter classes that provides convenience methods for parsing the data_path and labels_path parameters supported by many importers.
fiftyone.utils.data.importers.ImportPathsMixin._parse_data_path

fiftyone.utils.data.importers.ImportPathsMixin.html#_parse_data_path

Function

Static Method

PRIVATE

Helper function that computes default values for the data_path parameter supported by many importers.
fiftyone.utils.data.importers.ImportPathsMixin._parse_labels_path

fiftyone.utils.data.importers.ImportPathsMixin.html#_parse_labels_path

Function

Static Method

PRIVATE

Helper function that computes default values for the labels_path parameter supported by many importers.
fiftyone.utils.data.importers.ImportPathsMixin._load_data_map

fiftyone.utils.data.importers.ImportPathsMixin.html#_load_data_map

Function

Static Method

PRIVATE

Helper function that parses either a data directory or a data manifest file into a UUID -> filepath map.
fiftyone.utils.data.importers.DatasetImporter

fiftyone.utils.data.importers.DatasetImporter.html

Class

Class

PUBLIC

Base interface for importing datasets stored on disk into FiftyOne.
fiftyone.utils.data.importers.DatasetImporter.dataset_dir

fiftyone.utils.data.importers.DatasetImporter.html#dataset_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.DatasetImporter.shuffle

fiftyone.utils.data.importers.DatasetImporter.html#shuffle

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.DatasetImporter.seed

fiftyone.utils.data.importers.DatasetImporter.html#seed

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.DatasetImporter.max_samples

fiftyone.utils.data.importers.DatasetImporter.html#max_samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.DatasetImporter.__init__

fiftyone.utils.data.importers.DatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.DatasetImporter.__enter__

fiftyone.utils.data.importers.DatasetImporter.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.DatasetImporter.__exit__

fiftyone.utils.data.importers.DatasetImporter.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.DatasetImporter.__iter__

fiftyone.utils.data.importers.DatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.DatasetImporter.__len__

fiftyone.utils.data.importers.DatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.importers.DatasetImporter.__next__

fiftyone.utils.data.importers.DatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.DatasetImporter.has_dataset_info

fiftyone.utils.data.importers.DatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.importers.DatasetImporter.setup

fiftyone.utils.data.importers.DatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.importers.DatasetImporter.get_dataset_info

fiftyone.utils.data.importers.DatasetImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.data.importers.DatasetImporter.close

fiftyone.utils.data.importers.DatasetImporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been imported.
fiftyone.utils.data.importers.DatasetImporter._preprocess_list

fiftyone.utils.data.importers.DatasetImporter.html#_preprocess_list

Function

Method

PRIVATE

Internal utility that preprocesses the given list---which is presumed to be a list defining the samples that should be imported---by applying the values of the shuffle, seed, and max_samples parameters of the importer.
fiftyone.utils.data.importers._get_rng

fiftyone.utils.data.importers.html#_get_rng

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.importers.BatchDatasetImporter

fiftyone.utils.data.importers.BatchDatasetImporter.html

Class

Class

PUBLIC

Base interface for importers that load all of their samples in a single call to import_samples.
fiftyone.utils.data.importers.BatchDatasetImporter.__next__

fiftyone.utils.data.importers.BatchDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.BatchDatasetImporter.has_dataset_info

fiftyone.utils.data.importers.BatchDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.importers.BatchDatasetImporter.import_samples

fiftyone.utils.data.importers.BatchDatasetImporter.html#import_samples

Function

Method

PUBLIC

Imports the samples into the given dataset.
fiftyone.utils.data.importers.GenericSampleDatasetImporter

fiftyone.utils.data.importers.GenericSampleDatasetImporter.html

Class

Class

PUBLIC

Interface for importing datasets that contain arbitrary fiftyone.core.sample.Sample instances.
fiftyone.utils.data.importers.GenericSampleDatasetImporter.__next__

fiftyone.utils.data.importers.GenericSampleDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.GenericSampleDatasetImporter.has_sample_field_schema

fiftyone.utils.data.importers.GenericSampleDatasetImporter.html#has_sample_field_schema

Attribute

Property

PUBLIC

Whether this importer produces a sample field schema.
fiftyone.utils.data.importers.GenericSampleDatasetImporter.get_sample_field_schema

fiftyone.utils.data.importers.GenericSampleDatasetImporter.html#get_sample_field_schema

Function

Method

PUBLIC

Returns a dictionary describing the field schema of the samples loaded by this importer.
fiftyone.utils.data.importers.GroupDatasetImporter

fiftyone.utils.data.importers.GroupDatasetImporter.html

Class

Class

PUBLIC

Interface for importing datasets that contain arbitrary grouped fiftyone.core.sample.Sample instances.
fiftyone.utils.data.importers.GroupDatasetImporter.__len__

fiftyone.utils.data.importers.GroupDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported across all group slices.
fiftyone.utils.data.importers.GroupDatasetImporter.__next__

fiftyone.utils.data.importers.GroupDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next group in the dataset.
fiftyone.utils.data.importers.GroupDatasetImporter.group_field

fiftyone.utils.data.importers.GroupDatasetImporter.html#group_field

Attribute

Property

PUBLIC

The name of the group field to populate on each sample.
fiftyone.utils.data.importers.UnlabeledImageDatasetImporter

fiftyone.utils.data.importers.UnlabeledImageDatasetImporter.html

Class

Class

PUBLIC

Interface for importing datasets of unlabeled image samples.
fiftyone.utils.data.importers.UnlabeledImageDatasetImporter.__next__

fiftyone.utils.data.importers.UnlabeledImageDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.UnlabeledImageDatasetImporter.has_image_metadata

fiftyone.utils.data.importers.UnlabeledImageDatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter

fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter.html

Class

Class

PUBLIC

Interface for importing datasets of unlabeled video samples.
fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter.__next__

fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter.has_video_metadata

fiftyone.utils.data.importers.UnlabeledVideoDatasetImporter.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.VideoMetadata instances for each video.
fiftyone.utils.data.importers.UnlabeledMediaDatasetImporter

fiftyone.utils.data.importers.UnlabeledMediaDatasetImporter.html

Class

Class

PUBLIC

Interface for importing datasets of unlabeled media samples.
fiftyone.utils.data.importers.UnlabeledMediaDatasetImporter.__next__

fiftyone.utils.data.importers.UnlabeledMediaDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.UnlabeledMediaDatasetImporter.has_metadata

fiftyone.utils.data.importers.UnlabeledMediaDatasetImporter.html#has_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.Metadata instances for each sample.
fiftyone.utils.data.importers.LabeledImageDatasetImporter

fiftyone.utils.data.importers.LabeledImageDatasetImporter.html

Class

Class

PUBLIC

Interface for importing datasets of labeled image samples.
fiftyone.utils.data.importers.LabeledImageDatasetImporter.__next__

fiftyone.utils.data.importers.LabeledImageDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.LabeledImageDatasetImporter.has_image_metadata

fiftyone.utils.data.importers.LabeledImageDatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.data.importers.LabeledImageDatasetImporter.label_cls

fiftyone.utils.data.importers.LabeledImageDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.data.importers.LabeledVideoDatasetImporter

fiftyone.utils.data.importers.LabeledVideoDatasetImporter.html

Class

Class

PUBLIC

Interface for importing datasets of labeled video samples.
fiftyone.utils.data.importers.LabeledVideoDatasetImporter.__next__

fiftyone.utils.data.importers.LabeledVideoDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.LabeledVideoDatasetImporter.has_video_metadata

fiftyone.utils.data.importers.LabeledVideoDatasetImporter.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.VideoMetadata instances for each video.
fiftyone.utils.data.importers.LabeledVideoDatasetImporter.label_cls

fiftyone.utils.data.importers.LabeledVideoDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer within the sample-level labels that it produces.
fiftyone.utils.data.importers.LabeledVideoDatasetImporter.frame_labels_cls

fiftyone.utils.data.importers.LabeledVideoDatasetImporter.html#frame_labels_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer within the frame labels that it produces.
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html

Class

Class

PUBLIC

Legacy importer for FiftyOne datasets stored on disk in a serialized JSON format.
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.rel_dir

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.import_saved_views

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#import_saved_views

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.import_runs

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#import_runs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.import_workspaces

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#import_workspaces

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.__init__

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter._metadata

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#_metadata

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter._rel_dir

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#_rel_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter._fields_dir

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#_fields_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter._anno_dir

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#_anno_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter._brain_dir

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#_brain_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter._eval_dir

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#_eval_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter._runs_dir

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#_runs_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter._frame_labels_dir

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#_frame_labels_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter._samples

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter._iter_samples

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#_iter_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter._num_samples

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter._media_type

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#_media_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter._media_fields

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#_media_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.__iter__

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.__len__

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.__next__

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.has_sample_field_schema

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#has_sample_field_schema

Attribute

Property

PUBLIC

Whether this importer produces a sample field schema.
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.has_dataset_info

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.setup

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.get_sample_field_schema

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#get_sample_field_schema

Function

Method

PUBLIC

Returns a dictionary describing the field schema of the samples loaded by this importer.
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.get_dataset_info

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.import_extras

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#import_extras

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter._get_classes

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#_get_classes

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter._get_num_samples

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#_get_num_samples

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter._import_frame_labels

fiftyone.utils.data.importers.LegacyFiftyOneDatasetImporter.html#_import_frame_labels

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html

Class

Class

PUBLIC

Importer for FiftyOne datasets stored on disk in serialized JSON format.
fiftyone.utils.data.importers.FiftyOneDatasetImporter.rel_dir

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter.import_saved_views

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#import_saved_views

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter.import_runs

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#import_runs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter.import_workspaces

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#import_workspaces

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter.ordered

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#ordered

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter.__init__

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter._data_dir

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#_data_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter._fields_dir

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#_fields_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter._anno_dir

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#_anno_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter._brain_dir

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#_brain_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter._eval_dir

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#_eval_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter._runs_dir

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#_runs_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter._metadata_path

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#_metadata_path

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter._samples_path

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#_samples_path

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter._frames_path

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#_frames_path

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter._has_frames

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#_has_frames

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter._media_fields

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#_media_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter.setup

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.importers.FiftyOneDatasetImporter.import_samples

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#import_samples

Function

Method

PUBLIC

Imports the samples into the given dataset.
fiftyone.utils.data.importers.FiftyOneDatasetImporter._import_samples

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#_import_samples

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter._get_classes

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#_get_classes

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter._get_num_samples

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#_get_num_samples

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter._is_legacy_format_data

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#_is_legacy_format_data

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneDatasetImporter._to_legacy_importer

fiftyone.utils.data.importers.FiftyOneDatasetImporter.html#_to_legacy_importer

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.importers._set_created_at

fiftyone.utils.data.importers.html#_set_created_at

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.importers._import_saved_views

fiftyone.utils.data.importers.html#_import_saved_views

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.importers._import_workspaces

fiftyone.utils.data.importers.html#_import_workspaces

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.importers._import_runs

fiftyone.utils.data.importers.html#_import_runs

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.importers._parse_media_fields

fiftyone.utils.data.importers.html#_parse_media_fields

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.importers._parse_nested_media_field

fiftyone.utils.data.importers.html#_parse_nested_media_field

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImageDirectoryImporter

fiftyone.utils.data.importers.ImageDirectoryImporter.html

Class

Class

PUBLIC

Importer for a directory of images stored on disk.
fiftyone.utils.data.importers.ImageDirectoryImporter.recursive

fiftyone.utils.data.importers.ImageDirectoryImporter.html#recursive

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageDirectoryImporter.compute_metadata

fiftyone.utils.data.importers.ImageDirectoryImporter.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageDirectoryImporter.__init__

fiftyone.utils.data.importers.ImageDirectoryImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageDirectoryImporter._filepaths

fiftyone.utils.data.importers.ImageDirectoryImporter.html#_filepaths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImageDirectoryImporter._iter_filepaths

fiftyone.utils.data.importers.ImageDirectoryImporter.html#_iter_filepaths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImageDirectoryImporter._num_samples

fiftyone.utils.data.importers.ImageDirectoryImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImageDirectoryImporter.__iter__

fiftyone.utils.data.importers.ImageDirectoryImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageDirectoryImporter.__len__

fiftyone.utils.data.importers.ImageDirectoryImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.importers.ImageDirectoryImporter.__next__

fiftyone.utils.data.importers.ImageDirectoryImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.ImageDirectoryImporter.has_dataset_info

fiftyone.utils.data.importers.ImageDirectoryImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.importers.ImageDirectoryImporter.has_image_metadata

fiftyone.utils.data.importers.ImageDirectoryImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.data.importers.ImageDirectoryImporter.setup

fiftyone.utils.data.importers.ImageDirectoryImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.importers.ImageDirectoryImporter._get_num_samples

fiftyone.utils.data.importers.ImageDirectoryImporter.html#_get_num_samples

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.VideoDirectoryImporter

fiftyone.utils.data.importers.VideoDirectoryImporter.html

Class

Class

PUBLIC

Importer for a directory of videos stored on disk.
fiftyone.utils.data.importers.VideoDirectoryImporter.recursive

fiftyone.utils.data.importers.VideoDirectoryImporter.html#recursive

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.VideoDirectoryImporter.compute_metadata

fiftyone.utils.data.importers.VideoDirectoryImporter.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.VideoDirectoryImporter.__init__

fiftyone.utils.data.importers.VideoDirectoryImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.VideoDirectoryImporter._filepaths

fiftyone.utils.data.importers.VideoDirectoryImporter.html#_filepaths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.VideoDirectoryImporter._iter_filepaths

fiftyone.utils.data.importers.VideoDirectoryImporter.html#_iter_filepaths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.VideoDirectoryImporter._num_samples

fiftyone.utils.data.importers.VideoDirectoryImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.VideoDirectoryImporter.__iter__

fiftyone.utils.data.importers.VideoDirectoryImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.VideoDirectoryImporter.__len__

fiftyone.utils.data.importers.VideoDirectoryImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.importers.VideoDirectoryImporter.__next__

fiftyone.utils.data.importers.VideoDirectoryImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.VideoDirectoryImporter.has_dataset_info

fiftyone.utils.data.importers.VideoDirectoryImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.importers.VideoDirectoryImporter.has_video_metadata

fiftyone.utils.data.importers.VideoDirectoryImporter.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.VideoMetadata instances for each video.
fiftyone.utils.data.importers.VideoDirectoryImporter.setup

fiftyone.utils.data.importers.VideoDirectoryImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.importers.VideoDirectoryImporter._get_num_samples

fiftyone.utils.data.importers.VideoDirectoryImporter.html#_get_num_samples

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.MediaDirectoryImporter

fiftyone.utils.data.importers.MediaDirectoryImporter.html

Class

Class

PUBLIC

Importer for a directory of media files stored on disk.
fiftyone.utils.data.importers.MediaDirectoryImporter.recursive

fiftyone.utils.data.importers.MediaDirectoryImporter.html#recursive

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.MediaDirectoryImporter.compute_metadata

fiftyone.utils.data.importers.MediaDirectoryImporter.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.MediaDirectoryImporter.__init__

fiftyone.utils.data.importers.MediaDirectoryImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.MediaDirectoryImporter._filepaths

fiftyone.utils.data.importers.MediaDirectoryImporter.html#_filepaths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.MediaDirectoryImporter._iter_filepaths

fiftyone.utils.data.importers.MediaDirectoryImporter.html#_iter_filepaths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.MediaDirectoryImporter._num_samples

fiftyone.utils.data.importers.MediaDirectoryImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.MediaDirectoryImporter.__iter__

fiftyone.utils.data.importers.MediaDirectoryImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.MediaDirectoryImporter.__len__

fiftyone.utils.data.importers.MediaDirectoryImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.importers.MediaDirectoryImporter.__next__

fiftyone.utils.data.importers.MediaDirectoryImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.MediaDirectoryImporter.has_dataset_info

fiftyone.utils.data.importers.MediaDirectoryImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.importers.MediaDirectoryImporter.has_metadata

fiftyone.utils.data.importers.MediaDirectoryImporter.html#has_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.Metadata instances for each sample.
fiftyone.utils.data.importers.MediaDirectoryImporter.setup

fiftyone.utils.data.importers.MediaDirectoryImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.importers.MediaDirectoryImporter._get_num_samples

fiftyone.utils.data.importers.MediaDirectoryImporter.html#_get_num_samples

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html

Class

Class

PUBLIC

Importer for image classification datasets stored on disk in a simple JSON format.
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.data_path

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.labels_path

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.compute_metadata

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.include_all_data

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#include_all_data

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.__init__

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter._classes

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter._sample_parser

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#_sample_parser

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter._image_paths_map

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#_image_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter._labels_map

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#_labels_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter._uuids

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter._iter_uuids

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#_iter_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter._num_samples

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.__iter__

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.__len__

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.__next__

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.has_dataset_info

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.has_image_metadata

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.label_cls

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.setup

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.get_dataset_info

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter._get_classes

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#_get_classes

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter._get_num_samples

fiftyone.utils.data.importers.FiftyOneImageClassificationDatasetImporter.html#_get_num_samples

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html

Class

Class

PUBLIC

Importer for an image classification directory tree stored on disk.
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.compute_metadata

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.classes

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.unlabeled

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#unlabeled

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.__init__

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter._classes

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter._samples

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter._iter_samples

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#_iter_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter._num_samples

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.__iter__

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.__len__

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.__next__

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.has_image_metadata

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.has_dataset_info

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.label_cls

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.setup

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.get_dataset_info

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter._get_classes

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#_get_classes

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter._get_num_samples

fiftyone.utils.data.importers.ImageClassificationDirectoryTreeImporter.html#_get_num_samples

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers._to_list

fiftyone.utils.data.importers.html#_to_list

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html

Class

Class

PUBLIC

Importer for a viideo classification directory tree stored on disk.
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.compute_metadata

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.classes

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.unlabeled

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#unlabeled

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.__init__

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter._classes

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter._samples

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter._iter_samples

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#_iter_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter._num_samples

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.__iter__

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.__len__

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.__next__

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.has_video_metadata

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.VideoMetadata instances for each video.
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.has_dataset_info

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.label_cls

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer within the sample-level labels that it produces.
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.frame_labels_cls

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#frame_labels_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer within the frame labels that it produces.
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.setup

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.get_dataset_info

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter._get_classes

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#_get_classes

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter._get_num_samples

fiftyone.utils.data.importers.VideoClassificationDirectoryTreeImporter.html#_get_num_samples

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html

Class

Class

PUBLIC

Importer for image detection datasets stored on disk in a simple JSON format.
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.data_path

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.labels_path

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.compute_metadata

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.include_all_data

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#include_all_data

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.__init__

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter._classes

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter._sample_parser

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#_sample_parser

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter._image_paths_map

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#_image_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter._labels_map

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#_labels_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter._uuids

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter._iter_uuids

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#_iter_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter._num_samples

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.__iter__

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.__len__

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.__next__

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.has_dataset_info

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.has_image_metadata

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.label_cls

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.setup

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.get_dataset_info

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter._get_classes

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#_get_classes

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter._get_num_samples

fiftyone.utils.data.importers.FiftyOneImageDetectionDatasetImporter.html#_get_num_samples

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html

Class

Class

PUBLIC

Importer for temporal video detection datasets stored on disk in a simple JSON format.
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.data_path

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.labels_path

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.compute_metadata

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.include_all_data

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#include_all_data

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.__init__

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter._classes

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter._sample_parser

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#_sample_parser

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter._video_paths_map

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#_video_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter._labels_map

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#_labels_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter._uuids

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter._iter_uuids

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#_iter_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter._num_samples

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.__iter__

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.__len__

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.__next__

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.has_dataset_info

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.has_video_metadata

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.VideoMetadata instances for each video.
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.label_cls

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer within the sample-level labels that it produces.
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.frame_labels_cls

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#frame_labels_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer within the frame labels that it produces.
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.setup

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.get_dataset_info

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter._get_classes

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#_get_classes

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter._get_num_samples

fiftyone.utils.data.importers.FiftyOneTemporalDetectionDatasetImporter.html#_get_num_samples

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html

Class

Class

PUBLIC

Importer for image segmentation datasets stored on disk.
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.data_path

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.labels_path

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.load_masks

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#load_masks

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.force_grayscale

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#force_grayscale

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.compute_metadata

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.include_all_data

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#include_all_data

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.__init__

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter._image_paths_map

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#_image_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter._labels_paths_map

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#_labels_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter._uuids

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter._iter_uuids

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#_iter_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter._num_samples

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.__iter__

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.__len__

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.__next__

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.has_dataset_info

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.has_image_metadata

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.label_cls

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.setup

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter._get_num_samples

fiftyone.utils.data.importers.ImageSegmentationDirectoryImporter.html#_get_num_samples

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html

Class

Class

PUBLIC

Importer for labeled image datasets whose labels are stored in ETA ImageLabels format.
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.compute_metadata

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.prefix

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#prefix

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.labels_dict

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#labels_dict

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.multilabel

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#multilabel

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.skip_non_categorical

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#skip_non_categorical

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.__init__

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter._description

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter._sample_parser

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#_sample_parser

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter._samples

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter._iter_samples

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#_iter_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter._num_samples

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.__iter__

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.__len__

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.__next__

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.has_dataset_info

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.has_image_metadata

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.label_cls

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.setup

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.get_dataset_info

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter._get_num_samples

fiftyone.utils.data.importers.FiftyOneImageLabelsDatasetImporter.html#_get_num_samples

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html

Class

Class

PUBLIC

Importer for labeled video datasets whose labels are stored in ETA VideoLabels format.
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.compute_metadata

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.prefix

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#prefix

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.labels_dict

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#labels_dict

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.frame_labels_dict

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#frame_labels_dict

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.multilabel

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#multilabel

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.skip_non_categorical

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#skip_non_categorical

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.__init__

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter._description

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter._sample_parser

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#_sample_parser

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter._samples

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter._iter_samples

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#_iter_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter._num_samples

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.__iter__

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.__len__

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.__next__

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.has_dataset_info

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.has_video_metadata

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.VideoMetadata instances for each video.
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.label_cls

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer within the sample-level labels that it produces.
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.frame_labels_cls

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#frame_labels_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer within the frame labels that it produces.
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.setup

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.get_dataset_info

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter._get_num_samples

fiftyone.utils.data.importers.FiftyOneVideoLabelsDatasetImporter.html#_get_num_samples

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.data.importers._load_labeled_dataset_index

fiftyone.utils.data.importers.html#_load_labeled_dataset_index

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.converters.logger

fiftyone.utils.data.converters.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.data.converters.convert_dataset

fiftyone.utils.data.converters.html#convert_dataset

Function

Function

PUBLIC

Converts a dataset stored on disk to another format on disk.
fiftyone.utils.data.converters._is_tf_records

fiftyone.utils.data.converters.html#_is_tf_records

Function

Function

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.logger

fiftyone.utils.data.ingestors.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.ImageIngestor

fiftyone.utils.data.ingestors.ImageIngestor.html

Class

Class

PUBLIC

Mixin for fiftyone.utils.data.importers.DatasetImporter instances that ingest images into the provided dataset_dir during import.
fiftyone.utils.data.ingestors.ImageIngestor.image_format

fiftyone.utils.data.ingestors.ImageIngestor.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.ImageIngestor.__init__

fiftyone.utils.data.ingestors.ImageIngestor.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.ImageIngestor.dataset_dir

fiftyone.utils.data.ingestors.ImageIngestor.html#dataset_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.ImageIngestor._filename_maker

fiftyone.utils.data.ingestors.ImageIngestor.html#_filename_maker

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.ImageIngestor._ingest_image

fiftyone.utils.data.ingestors.ImageIngestor.html#_ingest_image

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.ImageIngestor._ingest_image_from_path

fiftyone.utils.data.ingestors.ImageIngestor.html#_ingest_image_from_path

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.ImageIngestor._ingest_in_memory_image

fiftyone.utils.data.ingestors.ImageIngestor.html#_ingest_in_memory_image

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.ImageIngestor._setup

fiftyone.utils.data.ingestors.ImageIngestor.html#_setup

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor

fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.html

Class

Class

PUBLIC

Dataset importer that ingests unlabeled images into the provided dataset_dir during import.
fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.__init__

fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.samples

fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.html#samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.sample_parser

fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.html#sample_parser

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor._iter_samples

fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.html#_iter_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor._num_samples

fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor._num_imported

fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.html#_num_imported

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.__iter__

fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.__len__

fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.__next__

fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.has_dataset_info

fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.has_image_metadata

fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.setup

fiftyone.utils.data.ingestors.UnlabeledImageDatasetIngestor.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor

fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.html

Class

Class

PUBLIC

Dataset importer that ingests labeled images into the provided dataset_dir during import.
fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.__init__

fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.samples

fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.html#samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.sample_parser

fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.html#sample_parser

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor._iter_samples

fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.html#_iter_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor._num_samples

fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor._num_imported

fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.html#_num_imported

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.__iter__

fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.__len__

fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.__next__

fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.has_dataset_info

fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.has_image_metadata

fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.label_cls

fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.setup

fiftyone.utils.data.ingestors.LabeledImageDatasetIngestor.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.ingestors.VideoIngestor

fiftyone.utils.data.ingestors.VideoIngestor.html

Class

Class

PUBLIC

Mixin for fiftyone.utils.data.importers.DatasetImporter instances that ingest videos into the provided dataset_dir during import.
fiftyone.utils.data.ingestors.VideoIngestor.__init__

fiftyone.utils.data.ingestors.VideoIngestor.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.VideoIngestor.dataset_dir

fiftyone.utils.data.ingestors.VideoIngestor.html#dataset_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.VideoIngestor._filename_maker

fiftyone.utils.data.ingestors.VideoIngestor.html#_filename_maker

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.VideoIngestor._ingest_video

fiftyone.utils.data.ingestors.VideoIngestor.html#_ingest_video

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.VideoIngestor._setup

fiftyone.utils.data.ingestors.VideoIngestor.html#_setup

Function

Method

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor

fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.html

Class

Class

PUBLIC

Dataset importer that ingests unlabeled videos into the provided dataset_dir during import.
fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.__init__

fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.samples

fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.html#samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.sample_parser

fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.html#sample_parser

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor._iter_samples

fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.html#_iter_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor._num_samples

fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor._num_imported

fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.html#_num_imported

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.__iter__

fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.__len__

fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.__next__

fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.has_dataset_info

fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.has_video_metadata

fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.VideoMetadata instances for each video.
fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.setup

fiftyone.utils.data.ingestors.UnlabeledVideoDatasetIngestor.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor

fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.html

Class

Class

PUBLIC

Dataset importer that ingests labeled videos into the provided dataset_dir during import.
fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.__init__

fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.samples

fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.html#samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.sample_parser

fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.html#sample_parser

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor._iter_samples

fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.html#_iter_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor._num_samples

fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor._num_imported

fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.html#_num_imported

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.__iter__

fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.__len__

fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.__next__

fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.has_dataset_info

fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.has_video_metadata

fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.VideoMetadata instances for each video.
fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.label_cls

fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer within the sample-level labels that it produces.
fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.frame_labels_cls

fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.html#frame_labels_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer within the frame labels that it produces.
fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.setup

fiftyone.utils.data.ingestors.LabeledVideoDatasetIngestor.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.dicom.logger

fiftyone.utils.dicom.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.dicom.DICOMSampleParser

fiftyone.utils.dicom.DICOMSampleParser.html

Class

Class

PUBLIC

Parser for labeled image samples stored in DICOM format.
fiftyone.utils.dicom.DICOMSampleParser.keywords

fiftyone.utils.dicom.DICOMSampleParser.html#keywords

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.dicom.DICOMSampleParser.parsers

fiftyone.utils.dicom.DICOMSampleParser.html#parsers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.dicom.DICOMSampleParser.__init__

fiftyone.utils.dicom.DICOMSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.dicom.DICOMSampleParser._ds

fiftyone.utils.dicom.DICOMSampleParser.html#_ds

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.dicom.DICOMSampleParser.label_cls

fiftyone.utils.dicom.DICOMSampleParser.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser.
fiftyone.utils.dicom.DICOMSampleParser.has_image_path

fiftyone.utils.dicom.DICOMSampleParser.html#has_image_path

Attribute

Property

PUBLIC

Whether this parser produces paths to images on disk for samples that it parses.
fiftyone.utils.dicom.DICOMSampleParser.has_image_metadata

fiftyone.utils.dicom.DICOMSampleParser.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.ImageMetadata instances for samples that it parses.
fiftyone.utils.dicom.DICOMSampleParser.get_image

fiftyone.utils.dicom.DICOMSampleParser.html#get_image

Function

Method

PUBLIC

Returns the image from the current sample.
fiftyone.utils.dicom.DICOMSampleParser.get_label

fiftyone.utils.dicom.DICOMSampleParser.html#get_label

Function

Method

PUBLIC

Returns the label for the current sample.
fiftyone.utils.dicom.DICOMSampleParser.clear_sample

fiftyone.utils.dicom.DICOMSampleParser.html#clear_sample

Function

Method

PUBLIC

Clears the current sample.
fiftyone.utils.dicom.DICOMSampleParser._ensure_ds

fiftyone.utils.dicom.DICOMSampleParser.html#_ensure_ds

Function

Method

PRIVATE

Undocumented
fiftyone.utils.dicom.DICOMDatasetImporter

fiftyone.utils.dicom.DICOMDatasetImporter.html

Class

Class

PUBLIC

Importer for DICOM datasets datasets stored on disk.
fiftyone.utils.dicom.DICOMDatasetImporter.dicom_path

fiftyone.utils.dicom.DICOMDatasetImporter.html#dicom_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.dicom.DICOMDatasetImporter.images_dir

fiftyone.utils.dicom.DICOMDatasetImporter.html#images_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.dicom.DICOMDatasetImporter.keywords

fiftyone.utils.dicom.DICOMDatasetImporter.html#keywords

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.dicom.DICOMDatasetImporter.parsers

fiftyone.utils.dicom.DICOMDatasetImporter.html#parsers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.dicom.DICOMDatasetImporter.image_format

fiftyone.utils.dicom.DICOMDatasetImporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.dicom.DICOMDatasetImporter.__init__

fiftyone.utils.dicom.DICOMDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.dicom.DICOMDatasetImporter._sample_parser

fiftyone.utils.dicom.DICOMDatasetImporter.html#_sample_parser

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.dicom.DICOMDatasetImporter._dataset_ingestor

fiftyone.utils.dicom.DICOMDatasetImporter.html#_dataset_ingestor

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.dicom.DICOMDatasetImporter._iter_dataset_ingestor

fiftyone.utils.dicom.DICOMDatasetImporter.html#_iter_dataset_ingestor

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.dicom.DICOMDatasetImporter._num_samples

fiftyone.utils.dicom.DICOMDatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.dicom.DICOMDatasetImporter.__len__

fiftyone.utils.dicom.DICOMDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.dicom.DICOMDatasetImporter.__iter__

fiftyone.utils.dicom.DICOMDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.dicom.DICOMDatasetImporter.__next__

fiftyone.utils.dicom.DICOMDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.dicom.DICOMDatasetImporter.label_cls

fiftyone.utils.dicom.DICOMDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.dicom.DICOMDatasetImporter.has_dataset_info

fiftyone.utils.dicom.DICOMDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.dicom.DICOMDatasetImporter.has_image_metadata

fiftyone.utils.dicom.DICOMDatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.dicom.DICOMDatasetImporter.setup

fiftyone.utils.dicom.DICOMDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.dicom.DICOMDatasetImporter.close

fiftyone.utils.dicom.DICOMDatasetImporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been imported.
fiftyone.utils.dicom._get_image

fiftyone.utils.dicom.html#_get_image

Function

Function

PRIVATE

Undocumented
fiftyone.utils.dicom._to_python

fiftyone.utils.dicom.html#_to_python

Function

Function

PRIVATE

Undocumented
fiftyone.utils.dicom._PRIMITIVE_TYPES

fiftyone.utils.dicom.html#_PRIMITIVE_TYPES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.dicom._LIST_TYPES

fiftyone.utils.dicom.html#_LIST_TYPES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.dicom._SCALAR_FIELD_TYPES_MAP

fiftyone.utils.dicom.html#_SCALAR_FIELD_TYPES_MAP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.eta._IMAGE_MODELS

fiftyone.utils.eta.html#_IMAGE_MODELS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.eta._VIDEO_MODELS

fiftyone.utils.eta.html#_VIDEO_MODELS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.eta.ETAModelConfig

fiftyone.utils.eta.ETAModelConfig.html

Class

Class

PUBLIC

Meta-config class that encapsulates the configuration of an eta.core.learning.Model that is to be run via the ETAModel wrapper.
fiftyone.utils.eta.ETAModelConfig.confidence_thresh

fiftyone.utils.eta.ETAModelConfig.html#confidence_thresh

Attribute

Property

PUBLIC

The confidence threshold of the underlying eta.core.model.Model.
fiftyone.utils.eta.ETAModelConfig.confidence_thresh.setter

fiftyone.utils.eta.ETAModelConfig.html#confidence_thresh.setter

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eta.ETAModel

fiftyone.utils.eta.ETAModel.html

Class

Class

PUBLIC

Wrapper for running an eta.core.learning.Model model.
fiftyone.utils.eta.ETAModel.__init__

fiftyone.utils.eta.ETAModel.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eta.ETAModel.config

fiftyone.utils.eta.ETAModel.html#config

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eta.ETAModel._model

fiftyone.utils.eta.ETAModel.html#_model

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.eta.ETAModel.__enter__

fiftyone.utils.eta.ETAModel.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eta.ETAModel.__exit__

fiftyone.utils.eta.ETAModel.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eta.ETAModel.media_type

fiftyone.utils.eta.ETAModel.html#media_type

Attribute

Property

PUBLIC

The media type processed by the model.
fiftyone.utils.eta.ETAModel.ragged_batches

fiftyone.utils.eta.ETAModel.html#ragged_batches

Attribute

Property

PUBLIC

True/False whether transforms may return tensors of different sizes. If True, then passing ragged lists of data to predict_all is not allowed.
fiftyone.utils.eta.ETAModel.transforms

fiftyone.utils.eta.ETAModel.html#transforms

Attribute

Property

PUBLIC

The preprocessing function that will/must be applied to each input before prediction, or None if no preprocessing is performed.
fiftyone.utils.eta.ETAModel.preprocess

fiftyone.utils.eta.ETAModel.html#preprocess

Attribute

Property

PUBLIC

Whether to apply transforms during inference (True) or to assume that they have already been applied (False).
fiftyone.utils.eta.ETAModel.preprocess.setter

fiftyone.utils.eta.ETAModel.html#preprocess.setter

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eta.ETAModel.has_logits

fiftyone.utils.eta.ETAModel.html#has_logits

Attribute

Property

PUBLIC

Whether this instance can generate logits for its predictions.
fiftyone.utils.eta.ETAModel.has_embeddings

fiftyone.utils.eta.ETAModel.html#has_embeddings

Attribute

Property

PUBLIC

Whether this instance can generate embeddings.
fiftyone.utils.eta.ETAModel._ensure_embeddings

fiftyone.utils.eta.ETAModel.html#_ensure_embeddings

Function

Method

PRIVATE

Undocumented
fiftyone.utils.eta.ETAModel.get_embeddings

fiftyone.utils.eta.ETAModel.html#get_embeddings

Function

Method

PUBLIC

Returns the embeddings generated by the last forward pass of the model.
fiftyone.utils.eta.ETAModel.embed

fiftyone.utils.eta.ETAModel.html#embed

Function

Method

PUBLIC

Generates an embedding for the given data.
fiftyone.utils.eta.ETAModel.embed_all

fiftyone.utils.eta.ETAModel.html#embed_all

Function

Method

PUBLIC

Generates embeddings for the given iterable of data.
fiftyone.utils.eta.ETAModel.predict

fiftyone.utils.eta.ETAModel.html#predict

Function

Method

PUBLIC

Performs prediction on the given data.
fiftyone.utils.eta.ETAModel.predict_all

fiftyone.utils.eta.ETAModel.html#predict_all

Function

Method

PUBLIC

Performs prediction on the given iterable of data.
fiftyone.utils.eta.ETAModel._parse_predictions

fiftyone.utils.eta.ETAModel.html#_parse_predictions

Function

Method

PRIVATE

Undocumented
fiftyone.utils.eta.ETAModel.from_eta_model

fiftyone.utils.eta.ETAModel.html#from_eta_model

Function

Class Method

PUBLIC

Builds an ETAModel for running the provided eta.core.learning.Model instance.
fiftyone.utils.eta.from_image_labels

fiftyone.utils.eta.html#from_image_labels

Function

Function

PUBLIC

Loads the eta.core.image.ImageLabels or eta.core.frames.FrameLabels into a dictionary of labels.
fiftyone.utils.eta.to_image_labels

fiftyone.utils.eta.html#to_image_labels

Function

Function

PUBLIC

Converts the image label(s) to eta.core.image.ImageLabels format.
fiftyone.utils.eta.from_video_labels

fiftyone.utils.eta.html#from_video_labels

Function

Function

PUBLIC

Loads the eta.core.video.VideoLabels into a frame labels dictionary.
fiftyone.utils.eta.to_video_labels

fiftyone.utils.eta.html#to_video_labels

Function

Function

PUBLIC

Converts the given labels to eta.core.video.VideoLabels format.
fiftyone.utils.eta.to_attribute

fiftyone.utils.eta.html#to_attribute

Function

Function

PUBLIC

Returns an eta.core.data.Attribute representation of the fiftyone.core.labels.Classification.
fiftyone.utils.eta.from_attribute

fiftyone.utils.eta.html#from_attribute

Function

Function

PUBLIC

Creates a fiftyone.core.labels.Classification from an eta.core.data.Attribute.
fiftyone.utils.eta.from_attributes

fiftyone.utils.eta.html#from_attributes

Function

Function

PUBLIC

Creates a fiftyone.core.labels.Classifications from a list of attributes.
fiftyone.utils.eta.to_detected_object

fiftyone.utils.eta.html#to_detected_object

Function

Function

PUBLIC

Returns an eta.core.objects.DetectedObject representation of the given fiftyone.core.labels.Detection.
fiftyone.utils.eta.from_detected_object

fiftyone.utils.eta.html#from_detected_object

Function

Function

PUBLIC

Creates a fiftyone.core.labels.Detection from an eta.core.objects.DetectedObject.
fiftyone.utils.eta.from_detected_objects

fiftyone.utils.eta.html#from_detected_objects

Function

Function

PUBLIC

Creates a fiftyone.core.labels.Detections from an eta.core.objects.DetectedObjectContainer.
fiftyone.utils.eta.to_polyline

fiftyone.utils.eta.html#to_polyline

Function

Function

PUBLIC

Returns an eta.core.polylines.Polyline representation of the given fiftyone.core.labels.Polyline.
fiftyone.utils.eta.from_polyline

fiftyone.utils.eta.html#from_polyline

Function

Function

PUBLIC

Creates a fiftyone.core.labels.Polyline from an eta.core.polylines.Polyline.
fiftyone.utils.eta.from_polylines

fiftyone.utils.eta.html#from_polylines

Function

Function

PUBLIC

Creates a fiftyone.core.labels.Polylines from an eta.core.polylines.PolylineContainer.
fiftyone.utils.eta.to_keypoints

fiftyone.utils.eta.html#to_keypoints

Function

Function

PUBLIC

Returns an eta.core.keypoints.Keypoints representation of the given fiftyone.core.labels.Keypoint.
fiftyone.utils.eta.from_keypoint

fiftyone.utils.eta.html#from_keypoint

Function

Function

PUBLIC

Creates a fiftyone.core.labels.Keypoint from an eta.core.keypoints.Keypoints.
fiftyone.utils.eta.from_keypoints

fiftyone.utils.eta.html#from_keypoints

Function

Function

PUBLIC

Creates a fiftyone.core.labels.Keypoints from an eta.core.keypoints.KeypointsContainer.
fiftyone.utils.eta.to_video_event

fiftyone.utils.eta.html#to_video_event

Function

Function

PUBLIC

Returns an eta.core.events.VideoEvent representation of the given fiftyone.core.labels.TemporalDetection.
fiftyone.utils.eta.from_video_event

fiftyone.utils.eta.html#from_video_event

Function

Function

PUBLIC

Creates a fiftyone.core.labels.TemporalDetection from an eta.core.events.VideoEvent.
fiftyone.utils.eta.from_video_events

fiftyone.utils.eta.html#from_video_events

Function

Function

PUBLIC

Creates a fiftyone.core.labels.TemporalDetections from an eta.core.events.VideoEventContainer.
fiftyone.utils.eta._add_frame_labels

fiftyone.utils.eta.html#_add_frame_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eta._add_video_labels

fiftyone.utils.eta.html#_add_video_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eta._from_eta_labels

fiftyone.utils.eta.html#_from_eta_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eta._from_eta_attributes

fiftyone.utils.eta.html#_from_eta_attributes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eta._to_eta_attributes

fiftyone.utils.eta.html#_to_eta_attributes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eta._expand_with_prefix

fiftyone.utils.eta.html#_expand_with_prefix

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eta._expand_with_labels_dict

fiftyone.utils.eta.html#_expand_with_labels_dict

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eta._squeeze_extra_unit_dims

fiftyone.utils.eta.html#_squeeze_extra_unit_dims

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eta._add_logits

fiftyone.utils.eta.html#_add_logits

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.activitynet.logger

fiftyone.utils.eval.activitynet.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig

fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.html

Class

Class

PUBLIC

ActivityNet-style evaluation config.
fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.compute_mAP

fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.html#compute_mAP

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.iou_threshs

fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.html#iou_threshs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.__init__

fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.method

fiftyone.utils.eval.activitynet.ActivityNetEvaluationConfig.html#method

Attribute

Property

PUBLIC

The name of the method.
fiftyone.utils.eval.activitynet.ActivityNetEvaluation

fiftyone.utils.eval.activitynet.ActivityNetEvaluation.html

Class

Class

PUBLIC

ActivityNet-style evaluation.
fiftyone.utils.eval.activitynet.ActivityNetEvaluation.__init__

fiftyone.utils.eval.activitynet.ActivityNetEvaluation.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.activitynet.ActivityNetEvaluation.evaluate

fiftyone.utils.eval.activitynet.ActivityNetEvaluation.html#evaluate

Function

Method

PUBLIC

Performs ActivityNet-style evaluation on the given video.
fiftyone.utils.eval.activitynet.ActivityNetEvaluation.generate_results

fiftyone.utils.eval.activitynet.ActivityNetEvaluation.html#generate_results

Function

Method

PUBLIC

Generates aggregate evaluation results for the samples.
fiftyone.utils.eval.activitynet.ActivityNetDetectionResults

fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.html

Class

Class

PUBLIC

Class that stores the results of a ActivityNet detection evaluation.
fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.thresholds

fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.html#thresholds

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.__init__

fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.precision

fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.html#precision

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.recall

fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.html#recall

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.iou_threshs

fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.html#iou_threshs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.activitynet.ActivityNetDetectionResults._classwise_AP

fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.html#_classwise_AP

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.plot_pr_curves

fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.html#plot_pr_curves

Function

Method

PUBLIC

Plots precision-recall (PR) curves for the results.
fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.mAP

fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.html#mAP

Function

Method

PUBLIC

Computes ActivityNet-style mean average precision (mAP) for the specified classes.
fiftyone.utils.eval.activitynet.ActivityNetDetectionResults._get_iou_thresh_inds

fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.html#_get_iou_thresh_inds

Function

Method

PRIVATE

Undocumented
fiftyone.utils.eval.activitynet.ActivityNetDetectionResults._get_class_index

fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.html#_get_class_index

Function

Method

PRIVATE

Undocumented
fiftyone.utils.eval.activitynet.ActivityNetDetectionResults._from_dict

fiftyone.utils.eval.activitynet.ActivityNetDetectionResults.html#_from_dict

Function

Class Method

PRIVATE

Subclass implementation of from_dict.
fiftyone.utils.eval.activitynet._NO_MATCH_ID

fiftyone.utils.eval.activitynet.html#_NO_MATCH_ID

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.eval.activitynet._NO_MATCH_IOU

fiftyone.utils.eval.activitynet.html#_NO_MATCH_IOU

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.eval.activitynet._activitynet_evaluation_single_iou

fiftyone.utils.eval.activitynet.html#_activitynet_evaluation_single_iou

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.activitynet._activitynet_evaluation_iou_sweep

fiftyone.utils.eval.activitynet.html#_activitynet_evaluation_iou_sweep

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.activitynet._activitynet_evaluation_setup

fiftyone.utils.eval.activitynet.html#_activitynet_evaluation_setup

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.activitynet._compute_matches

fiftyone.utils.eval.activitynet.html#_compute_matches

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.activitynet._copy_labels

fiftyone.utils.eval.activitynet.html#_copy_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.coco.logger

fiftyone.utils.eval.coco.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCOEvaluationConfig

fiftyone.utils.eval.coco.COCOEvaluationConfig.html

Class

Class

PUBLIC

COCO-style evaluation config.
fiftyone.utils.eval.coco.COCOEvaluationConfig.iscrowd

fiftyone.utils.eval.coco.COCOEvaluationConfig.html#iscrowd

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCOEvaluationConfig.use_masks

fiftyone.utils.eval.coco.COCOEvaluationConfig.html#use_masks

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCOEvaluationConfig.use_boxes

fiftyone.utils.eval.coco.COCOEvaluationConfig.html#use_boxes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCOEvaluationConfig.tolerance

fiftyone.utils.eval.coco.COCOEvaluationConfig.html#tolerance

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCOEvaluationConfig.compute_mAP

fiftyone.utils.eval.coco.COCOEvaluationConfig.html#compute_mAP

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCOEvaluationConfig.iou_threshs

fiftyone.utils.eval.coco.COCOEvaluationConfig.html#iou_threshs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCOEvaluationConfig.max_preds

fiftyone.utils.eval.coco.COCOEvaluationConfig.html#max_preds

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCOEvaluationConfig.error_level

fiftyone.utils.eval.coco.COCOEvaluationConfig.html#error_level

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCOEvaluationConfig.__init__

fiftyone.utils.eval.coco.COCOEvaluationConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCOEvaluationConfig.method

fiftyone.utils.eval.coco.COCOEvaluationConfig.html#method

Attribute

Property

PUBLIC

The name of the method.
fiftyone.utils.eval.coco.COCOEvaluation

fiftyone.utils.eval.coco.COCOEvaluation.html

Class

Class

PUBLIC

COCO-style evaluation.
fiftyone.utils.eval.coco.COCOEvaluation.__init__

fiftyone.utils.eval.coco.COCOEvaluation.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCOEvaluation.evaluate

fiftyone.utils.eval.coco.COCOEvaluation.html#evaluate

Function

Method

PUBLIC

Performs COCO-style evaluation on the given image.
fiftyone.utils.eval.coco.COCOEvaluation.generate_results

fiftyone.utils.eval.coco.COCOEvaluation.html#generate_results

Function

Method

PUBLIC

Generates aggregate evaluation results for the samples.
fiftyone.utils.eval.coco.COCODetectionResults

fiftyone.utils.eval.coco.COCODetectionResults.html

Class

Class

PUBLIC

Class that stores the results of a COCO detection evaluation.
fiftyone.utils.eval.coco.COCODetectionResults.recall_sweep

fiftyone.utils.eval.coco.COCODetectionResults.html#recall_sweep

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCODetectionResults.thresholds

fiftyone.utils.eval.coco.COCODetectionResults.html#thresholds

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCODetectionResults.__init__

fiftyone.utils.eval.coco.COCODetectionResults.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCODetectionResults.precision

fiftyone.utils.eval.coco.COCODetectionResults.html#precision

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCODetectionResults.recall

fiftyone.utils.eval.coco.COCODetectionResults.html#recall

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCODetectionResults.iou_threshs

fiftyone.utils.eval.coco.COCODetectionResults.html#iou_threshs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.coco.COCODetectionResults._classwise_AP

fiftyone.utils.eval.coco.COCODetectionResults.html#_classwise_AP

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.eval.coco.COCODetectionResults._classwise_AR

fiftyone.utils.eval.coco.COCODetectionResults.html#_classwise_AR

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.eval.coco.COCODetectionResults.plot_pr_curves

fiftyone.utils.eval.coco.COCODetectionResults.html#plot_pr_curves

Function

Method

PUBLIC

Plots precision-recall (PR) curves for the results.
fiftyone.utils.eval.coco.COCODetectionResults.mAP

fiftyone.utils.eval.coco.COCODetectionResults.html#mAP

Function

Method

PUBLIC

Computes COCO-style mean average precision (mAP) for the specified classes.
fiftyone.utils.eval.coco.COCODetectionResults.mAR

fiftyone.utils.eval.coco.COCODetectionResults.html#mAR

Function

Method

PUBLIC

Computes COCO-style mean average recall (mAR) for the specified classes.
fiftyone.utils.eval.coco.COCODetectionResults._get_iou_thresh_inds

fiftyone.utils.eval.coco.COCODetectionResults.html#_get_iou_thresh_inds

Function

Method

PRIVATE

Undocumented
fiftyone.utils.eval.coco.COCODetectionResults._get_class_index

fiftyone.utils.eval.coco.COCODetectionResults.html#_get_class_index

Function

Method

PRIVATE

Undocumented
fiftyone.utils.eval.coco.COCODetectionResults._from_dict

fiftyone.utils.eval.coco.COCODetectionResults.html#_from_dict

Function

Class Method

PRIVATE

Subclass implementation of from_dict.
fiftyone.utils.eval.coco._NO_MATCH_ID

fiftyone.utils.eval.coco.html#_NO_MATCH_ID

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.eval.coco._NO_MATCH_IOU

fiftyone.utils.eval.coco.html#_NO_MATCH_IOU

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.eval.coco._coco_evaluation_single_iou

fiftyone.utils.eval.coco.html#_coco_evaluation_single_iou

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.coco._coco_evaluation_iou_sweep

fiftyone.utils.eval.coco.html#_coco_evaluation_iou_sweep

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.coco._coco_evaluation_setup

fiftyone.utils.eval.coco.html#_coco_evaluation_setup

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.coco._compute_matches

fiftyone.utils.eval.coco.html#_compute_matches

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.coco._compute_pr_curves

fiftyone.utils.eval.coco.html#_compute_pr_curves

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.coco._copy_labels

fiftyone.utils.eval.coco.html#_copy_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html

Class

Class

PUBLIC

Open Images-style evaluation config.
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.iscrowd

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html#iscrowd

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.use_masks

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html#use_masks

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.use_boxes

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html#use_boxes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.tolerance

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html#tolerance

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.max_preds

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html#max_preds

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.error_level

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html#error_level

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.hierarchy

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html#hierarchy

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.pos_label_field

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html#pos_label_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.neg_label_field

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html#neg_label_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.expand_gt_hierarchy

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html#expand_gt_hierarchy

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.expand_pred_hierarchy

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html#expand_pred_hierarchy

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.__init__

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig._hierarchy_keyed_parent

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html#_hierarchy_keyed_parent

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig._hierarchy_keyed_child

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html#_hierarchy_keyed_child

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.method

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html#method

Attribute

Property

PUBLIC

The name of the method.
fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.requires_additional_fields

fiftyone.utils.eval.openimages.OpenImagesEvaluationConfig.html#requires_additional_fields

Attribute

Property

PUBLIC

Whether fields besides pred_field and gt_field are required in order to perform evaluation.
fiftyone.utils.eval.openimages.OpenImagesEvaluation

fiftyone.utils.eval.openimages.OpenImagesEvaluation.html

Class

Class

PUBLIC

Open Images-style evaluation.
fiftyone.utils.eval.openimages.OpenImagesEvaluation.__init__

fiftyone.utils.eval.openimages.OpenImagesEvaluation.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesEvaluation.evaluate

fiftyone.utils.eval.openimages.OpenImagesEvaluation.html#evaluate

Function

Method

PUBLIC

Performs Open Images-style evaluation on the given image.
fiftyone.utils.eval.openimages.OpenImagesEvaluation.generate_results

fiftyone.utils.eval.openimages.OpenImagesEvaluation.html#generate_results

Function

Method

PUBLIC

Generates aggregate evaluation results for the samples.
fiftyone.utils.eval.openimages.OpenImagesDetectionResults

fiftyone.utils.eval.openimages.OpenImagesDetectionResults.html

Class

Class

PUBLIC

Class that stores the results of an Open Images detection evaluation.
fiftyone.utils.eval.openimages.OpenImagesDetectionResults.thresholds

fiftyone.utils.eval.openimages.OpenImagesDetectionResults.html#thresholds

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesDetectionResults.__init__

fiftyone.utils.eval.openimages.OpenImagesDetectionResults.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesDetectionResults.precision

fiftyone.utils.eval.openimages.OpenImagesDetectionResults.html#precision

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesDetectionResults.recall

fiftyone.utils.eval.openimages.OpenImagesDetectionResults.html#recall

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.eval.openimages.OpenImagesDetectionResults._classwise_AP

fiftyone.utils.eval.openimages.OpenImagesDetectionResults.html#_classwise_AP

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.eval.openimages.OpenImagesDetectionResults.plot_pr_curves

fiftyone.utils.eval.openimages.OpenImagesDetectionResults.html#plot_pr_curves

Function

Method

PUBLIC

Plots precision-recall (PR) curves for the detection results.
fiftyone.utils.eval.openimages.OpenImagesDetectionResults.mAP

fiftyone.utils.eval.openimages.OpenImagesDetectionResults.html#mAP

Function

Method

PUBLIC

Computes Open Images-style mean average precision (mAP) for the specified classes.
fiftyone.utils.eval.openimages.OpenImagesDetectionResults._validate_classes

fiftyone.utils.eval.openimages.OpenImagesDetectionResults.html#_validate_classes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.eval.openimages.OpenImagesDetectionResults._from_dict

fiftyone.utils.eval.openimages.OpenImagesDetectionResults.html#_from_dict

Function

Class Method

PRIVATE

Subclass implementation of from_dict.
fiftyone.utils.eval.openimages._NO_MATCH_ID

fiftyone.utils.eval.openimages.html#_NO_MATCH_ID

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.eval.openimages._NO_MATCH_IOU

fiftyone.utils.eval.openimages.html#_NO_MATCH_IOU

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.eval.openimages._expand_label_hierarchy

fiftyone.utils.eval.openimages.html#_expand_label_hierarchy

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.openimages._expand_detection_hierarchy

fiftyone.utils.eval.openimages.html#_expand_detection_hierarchy

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.openimages._open_images_evaluation_single_iou

fiftyone.utils.eval.openimages.html#_open_images_evaluation_single_iou

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.openimages._open_images_evaluation_setup

fiftyone.utils.eval.openimages.html#_open_images_evaluation_setup

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.openimages._compute_matches

fiftyone.utils.eval.openimages.html#_compute_matches

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.openimages._compute_pr_curves

fiftyone.utils.eval.openimages.html#_compute_pr_curves

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.openimages._compute_AP

fiftyone.utils.eval.openimages.html#_compute_AP

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.openimages._interpolate_pr

fiftyone.utils.eval.openimages.html#_interpolate_pr

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.openimages._copy_labels

fiftyone.utils.eval.openimages.html#_copy_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.eval.openimages._update_dict

fiftyone.utils.eval.openimages.html#_update_dict

Function

Function

PRIVATE

Updates dictionary with update content
fiftyone.utils.eval.openimages._build_plain_hierarchy

fiftyone.utils.eval.openimages.html#_build_plain_hierarchy

Function

Function

PRIVATE

Expands tree hierarchy representation to parent-child dictionary.
fiftyone.utils.fiw.logger

fiftyone.utils.fiw.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.fiw.FIWDatasetImporter

fiftyone.utils.fiw.FIWDatasetImporter.html

Class

Class

PUBLIC

Importer for Faces in the Wild-formatted datasets stored on disk.
fiftyone.utils.fiw.FIWDatasetImporter.import_samples

fiftyone.utils.fiw.FIWDatasetImporter.html#import_samples

Function

Method

PUBLIC

Imports samples and labels stored on disk following the format of the Families in the Wild dataset.
fiftyone.utils.fiw.get_pairwise_labels

fiftyone.utils.fiw.html#get_pairwise_labels

Function

Function

PUBLIC

Gets a list of all pairs of people that are related and the label of their relation, either through the "kinships" or "relationships" field.
fiftyone.utils.fiw.get_identifier_filepaths_map

fiftyone.utils.fiw.html#get_identifier_filepaths_map

Function

Function

PUBLIC

Creates a mapping of family_id/member_id identifier to a list of filepaths for each person.
fiftyone.utils.fiw._load_split

fiftyone.utils.fiw.html#_load_split

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw._load_member

fiftyone.utils.fiw.html#_load_member

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw._get_relationships

fiftyone.utils.fiw.html#_get_relationships

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw._get_picture_face

fiftyone.utils.fiw.html#_get_picture_face

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw._get_mid

fiftyone.utils.fiw.html#_get_mid

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw._format_mid

fiftyone.utils.fiw.html#_format_mid

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw._get_name

fiftyone.utils.fiw.html#_get_name

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw._get_gender

fiftyone.utils.fiw.html#_get_gender

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw._parse_kinship_map

fiftyone.utils.fiw.html#_parse_kinship_map

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw._parse_identifier

fiftyone.utils.fiw.html#_parse_identifier

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw.download_fiw_dataset

fiftyone.utils.fiw.html#download_fiw_dataset

Function

Function

PUBLIC

Downloads and extracts the Families in the Wild dataset.
fiftyone.utils.fiw._download_images_if_necessary

fiftyone.utils.fiw.html#_download_images_if_necessary

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw._is_missing_images

fiftyone.utils.fiw.html#_is_missing_images

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw._organize_data

fiftyone.utils.fiw.html#_organize_data

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw._is_missing_labels

fiftyone.utils.fiw.html#_is_missing_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw._download_labels_if_necessary

fiftyone.utils.fiw.html#_download_labels_if_necessary

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw._organize_labels

fiftyone.utils.fiw.html#_organize_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw._get_dataset_info

fiftyone.utils.fiw.html#_get_dataset_info

Function

Function

PRIVATE

Undocumented
fiftyone.utils.fiw._SPLITS

fiftyone.utils.fiw.html#_SPLITS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.fiw._RELATIONSHIP_MAP

fiftyone.utils.fiw.html#_RELATIONSHIP_MAP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.fiw._IMAGES_DOWNLOAD_LINK

fiftyone.utils.fiw.html#_IMAGES_DOWNLOAD_LINK

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.fiw._MD5_DATA_DOWNLOAD_LINK

fiftyone.utils.fiw.html#_MD5_DATA_DOWNLOAD_LINK

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.fiw._LISTS_DOWNLOAD_LINK

fiftyone.utils.fiw.html#_LISTS_DOWNLOAD_LINK

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.fiw._MD5_LISTS_DOWNLOAD_LINK

fiftyone.utils.fiw.html#_MD5_LISTS_DOWNLOAD_LINK

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.flash._SUPPORTED_MODELS

fiftyone.utils.flash.html#_SUPPORTED_MODELS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.flash.apply_flash_model

fiftyone.utils.flash.html#apply_flash_model

Function

Function

PUBLIC

Applies the given Lightning Flash model to the samples in the collection.
fiftyone.utils.flash._export_arrays

fiftyone.utils.flash.html#_export_arrays

Function

Function

PRIVATE

Undocumented
fiftyone.utils.flash._do_export_array

fiftyone.utils.flash.html#_do_export_array

Function

Function

PRIVATE

Undocumented
fiftyone.utils.flash.compute_flash_embeddings

fiftyone.utils.flash.html#compute_flash_embeddings

Function

Function

PUBLIC

Computes embeddings for the samples in the collection using the given Lightning Flash model.
fiftyone.utils.flash._get_output

fiftyone.utils.flash.html#_get_output

Function

Function

PRIVATE

Undocumented
fiftyone.utils.flash._MODEL_TO_DATAMODULE_MAP

fiftyone.utils.flash.html#_MODEL_TO_DATAMODULE_MAP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.geojson.logger

fiftyone.utils.geojson.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.load_location_data

fiftyone.utils.geojson.html#load_location_data

Function

Function

PUBLIC

Loads geolocation data for the given samples from the given GeoJSON data.
fiftyone.utils.geojson.to_geo_json_geometry

fiftyone.utils.geojson.html#to_geo_json_geometry

Function

Function

PUBLIC

Returns a GeoJSON geometry dict representation for the given location.
fiftyone.utils.geojson.parse_point

fiftyone.utils.geojson.html#parse_point

Function

Function

PUBLIC

Parses the point into GeoJSON dict representation.
fiftyone.utils.geojson.parse_polygon

fiftyone.utils.geojson.html#parse_polygon

Function

Function

PUBLIC

Parses the polygon or multi-polygon into GeoJSON dict representation.
fiftyone.utils.geojson.geo_within

fiftyone.utils.geojson.html#geo_within

Function

Function

PUBLIC

Creates a MongoDB query expression that tests whether the given location field is contained within the specified boundary shape.
fiftyone.utils.geojson.extract_coordinates

fiftyone.utils.geojson.html#extract_coordinates

Function

Function

PUBLIC

Extracts the coordinates from all geometries in the GeoJSON dictionary.
fiftyone.utils.geojson.GeoJSONDatasetImporter

fiftyone.utils.geojson.GeoJSONDatasetImporter.html

Class

Class

PUBLIC

Importer for image or video datasets whose location data and labels are stored in GeoJSON format.
fiftyone.utils.geojson.GeoJSONDatasetImporter.data_path

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetImporter.labels_path

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetImporter.location_field

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#location_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetImporter.multi_location

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#multi_location

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetImporter.property_parsers

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#property_parsers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetImporter.skip_missing_media

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#skip_missing_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetImporter.include_all_data

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#include_all_data

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetImporter.__init__

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetImporter._media_paths_map

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#_media_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetImporter._features_map

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#_features_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetImporter._filepaths

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#_filepaths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetImporter._iter_filepaths

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#_iter_filepaths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetImporter._num_samples

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetImporter.__iter__

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetImporter.__len__

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.geojson.GeoJSONDatasetImporter.__next__

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.geojson.GeoJSONDatasetImporter.has_sample_field_schema

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#has_sample_field_schema

Attribute

Property

PUBLIC

Whether this importer produces a sample field schema.
fiftyone.utils.geojson.GeoJSONDatasetImporter.has_dataset_info

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.geojson.GeoJSONDatasetImporter.setup

fiftyone.utils.geojson.GeoJSONDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.geojson.GeoJSONDatasetExporter

fiftyone.utils.geojson.GeoJSONDatasetExporter.html

Class

Class

PUBLIC

Exporter for image or video datasets whose location data and labels are stored in GeoJSON format.
fiftyone.utils.geojson.GeoJSONDatasetExporter.data_path

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetExporter.labels_path

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetExporter.export_media

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetExporter.rel_dir

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetExporter.abs_paths

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#abs_paths

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetExporter.image_format

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetExporter.location_field

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#location_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetExporter.property_makers

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#property_makers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetExporter.omit_none_fields

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#omit_none_fields

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetExporter.pretty_print

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#pretty_print

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetExporter.__init__

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetExporter._features

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#_features

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetExporter._location_field

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#_location_field

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetExporter._media_exporter

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.geojson.GeoJSONDatasetExporter.setup

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.geojson.GeoJSONDatasetExporter.log_collection

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#log_collection

Function

Method

PUBLIC

Logs any relevant information about the fiftyone.core.collections.SampleCollection whose samples will be exported.
fiftyone.utils.geojson.GeoJSONDatasetExporter.export_sample

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.geojson.GeoJSONDatasetExporter.close

fiftyone.utils.geojson.GeoJSONDatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.geojson._to_geo_primitive

fiftyone.utils.geojson.html#_to_geo_primitive

Function

Function

PRIVATE

Undocumented
fiftyone.utils.geojson._to_geo_collection

fiftyone.utils.geojson.html#_to_geo_collection

Function

Function

PRIVATE

Undocumented
fiftyone.utils.geojson._to_multi_geo_collection

fiftyone.utils.geojson.html#_to_multi_geo_collection

Function

Function

PRIVATE

Undocumented
fiftyone.utils.geojson._make_geometry

fiftyone.utils.geojson.html#_make_geometry

Function

Function

PRIVATE

Undocumented
fiftyone.utils.geojson._parse_geometries

fiftyone.utils.geojson.html#_parse_geometries

Function

Function

PRIVATE

Undocumented
fiftyone.utils.geojson._ensure_type

fiftyone.utils.geojson.html#_ensure_type

Function

Function

PRIVATE

Undocumented
fiftyone.utils.geotiff.pyproj

fiftyone.utils.geotiff.html#pyproj

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.geotiff.rasterio

fiftyone.utils.geotiff.html#rasterio

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.geotiff.get_geolocation

fiftyone.utils.geotiff.html#get_geolocation

Function

Function

PUBLIC

Retrieves the geolocation information from the given GeoTIFF image.
fiftyone.utils.geotiff.GeoTIFFDatasetImporter

fiftyone.utils.geotiff.GeoTIFFDatasetImporter.html

Class

Class

PUBLIC

Importer for a directory of GeoTIFF images with geolocation data.
fiftyone.utils.geotiff.GeoTIFFDatasetImporter.image_path

fiftyone.utils.geotiff.GeoTIFFDatasetImporter.html#image_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geotiff.GeoTIFFDatasetImporter.recursive

fiftyone.utils.geotiff.GeoTIFFDatasetImporter.html#recursive

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geotiff.GeoTIFFDatasetImporter.compute_metadata

fiftyone.utils.geotiff.GeoTIFFDatasetImporter.html#compute_metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.geotiff.GeoTIFFDatasetImporter.__init__

fiftyone.utils.geotiff.GeoTIFFDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.geotiff.GeoTIFFDatasetImporter._filepaths

fiftyone.utils.geotiff.GeoTIFFDatasetImporter.html#_filepaths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.geotiff.GeoTIFFDatasetImporter._iter_filepaths

fiftyone.utils.geotiff.GeoTIFFDatasetImporter.html#_iter_filepaths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.geotiff.GeoTIFFDatasetImporter._num_samples

fiftyone.utils.geotiff.GeoTIFFDatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.geotiff.GeoTIFFDatasetImporter.__iter__

fiftyone.utils.geotiff.GeoTIFFDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.geotiff.GeoTIFFDatasetImporter.__len__

fiftyone.utils.geotiff.GeoTIFFDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.geotiff.GeoTIFFDatasetImporter.__next__

fiftyone.utils.geotiff.GeoTIFFDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.geotiff.GeoTIFFDatasetImporter.has_image_metadata

fiftyone.utils.geotiff.GeoTIFFDatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.geotiff.GeoTIFFDatasetImporter.has_dataset_info

fiftyone.utils.geotiff.GeoTIFFDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.geotiff.GeoTIFFDatasetImporter.label_cls

fiftyone.utils.geotiff.GeoTIFFDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.geotiff.GeoTIFFDatasetImporter.setup

fiftyone.utils.geotiff.GeoTIFFDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.groups.group_collections

fiftyone.utils.groups.html#group_collections

Function

Function

PUBLIC

Merges the given collections into a grouped dataset using the specified field as a group key.
fiftyone.utils.groups._add_slice

fiftyone.utils.groups.html#_add_slice

Function

Function

PRIVATE

Undocumented
fiftyone.utils.hmdb51.logger

fiftyone.utils.hmdb51.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.hmdb51.download_hmdb51_dataset

fiftyone.utils.hmdb51.html#download_hmdb51_dataset

Function

Function

PUBLIC

Downloads and extracts the HMDB51 dataset.
fiftyone.utils.hmdb51._VIDEOS_DOWNLOAD_LINK

fiftyone.utils.hmdb51.html#_VIDEOS_DOWNLOAD_LINK

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.hmdb51._SPLITS_DOWNLOAD_LINK

fiftyone.utils.hmdb51.html#_SPLITS_DOWNLOAD_LINK

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.hmdb51._download_videos

fiftyone.utils.hmdb51.html#_download_videos

Function

Function

PRIVATE

Undocumented
fiftyone.utils.hmdb51._download_splits

fiftyone.utils.hmdb51.html#_download_splits

Function

Function

PRIVATE

Undocumented
fiftyone.utils.hmdb51._load_split_info

fiftyone.utils.hmdb51.html#_load_split_info

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface.hfh

fiftyone.utils.huggingface.html#hfh

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.huggingface.DATASETS_SERVER_URL

fiftyone.utils.huggingface.html#DATASETS_SERVER_URL

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.huggingface.DEFAULT_MEDIA_TYPE

fiftyone.utils.huggingface.html#DEFAULT_MEDIA_TYPE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.huggingface.DATASET_METADATA_FILENAMES

fiftyone.utils.huggingface.html#DATASET_METADATA_FILENAMES

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.huggingface.DATASETS_MAX_BATCH_SIZE

fiftyone.utils.huggingface.html#DATASETS_MAX_BATCH_SIZE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.huggingface.DEFAULT_BATCH_SIZE

fiftyone.utils.huggingface.html#DEFAULT_BATCH_SIZE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.huggingface.DEFAULT_IMAGE_FILEPATH_FEATURE

fiftyone.utils.huggingface.html#DEFAULT_IMAGE_FILEPATH_FEATURE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.huggingface.FIFTYONE_BUILTIN_FIELDS

fiftyone.utils.huggingface.html#FIFTYONE_BUILTIN_FIELDS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.huggingface.SUPPORTED_DTYPES

fiftyone.utils.huggingface.html#SUPPORTED_DTYPES

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.huggingface.logger

fiftyone.utils.huggingface.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.huggingface.list_hub_datasets

fiftyone.utils.huggingface.html#list_hub_datasets

Function

Function

PUBLIC

Lists all FiftyOne datasets available on the Hugging Face Hub.
fiftyone.utils.huggingface.push_to_hub

fiftyone.utils.huggingface.html#push_to_hub

Function

Function

PUBLIC

Push a FiftyOne dataset to the Hugging Face Hub.
fiftyone.utils.huggingface.load_from_hub

fiftyone.utils.huggingface.html#load_from_hub

Function

Function

PUBLIC

Loads a dataset from the Hugging Face Hub into FiftyOne.
fiftyone.utils.huggingface.HFHubDatasetConfig

fiftyone.utils.huggingface.HFHubDatasetConfig.html

Class

Class

PUBLIC

Config for a Hugging Face Hub dataset.
fiftyone.utils.huggingface.HFHubDatasetConfig.__init__

fiftyone.utils.huggingface.HFHubDatasetConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.huggingface.HFHubDatasetConfig._repo_type

fiftyone.utils.huggingface.HFHubDatasetConfig.html#_repo_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.huggingface.HFHubDatasetConfig._repo_id

fiftyone.utils.huggingface.HFHubDatasetConfig.html#_repo_id

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.huggingface.HFHubDatasetConfig._revision

fiftyone.utils.huggingface.HFHubDatasetConfig.html#_revision

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.huggingface.HFHubDatasetConfig._filename

fiftyone.utils.huggingface.HFHubDatasetConfig.html#_filename

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.huggingface.HFHubDatasetConfig._format

fiftyone.utils.huggingface.HFHubDatasetConfig.html#_format

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.huggingface.HFHubDatasetConfig.tags

fiftyone.utils.huggingface.HFHubDatasetConfig.html#tags

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.huggingface.HFHubDatasetConfig.license

fiftyone.utils.huggingface.HFHubDatasetConfig.html#license

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.huggingface.HFHubDatasetConfig.description

fiftyone.utils.huggingface.HFHubDatasetConfig.html#description

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.huggingface.HFHubDatasetConfig.app_media_fields

fiftyone.utils.huggingface.HFHubDatasetConfig.html#app_media_fields

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.huggingface.HFHubDatasetConfig.grid_media_field

fiftyone.utils.huggingface.HFHubDatasetConfig.html#grid_media_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.huggingface.HFHubDatasetConfig._get_fiftyone_version

fiftyone.utils.huggingface.HFHubDatasetConfig.html#_get_fiftyone_version

Function

Method

PRIVATE

Undocumented
fiftyone.utils.huggingface.HFHubDatasetConfig.version

fiftyone.utils.huggingface.HFHubDatasetConfig.html#version

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.huggingface.DATASET_CONTENT_TEMPLATE

fiftyone.utils.huggingface.html#DATASET_CONTENT_TEMPLATE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.huggingface._extract_number

fiftyone.utils.huggingface.html#_extract_number

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._is_already_uploaded

fiftyone.utils.huggingface.html#_is_already_uploaded

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._upload_data_to_repo

fiftyone.utils.huggingface.html#_upload_data_to_repo

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._populate_config_file

fiftyone.utils.huggingface.html#_populate_config_file

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_dataset_tasks

fiftyone.utils.huggingface.html#_get_dataset_tasks

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_dataset_tags

fiftyone.utils.huggingface.html#_get_dataset_tags

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._generate_dataset_summary

fiftyone.utils.huggingface.html#_generate_dataset_summary

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_size_category

fiftyone.utils.huggingface.html#_get_size_category

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._create_dataset_card

fiftyone.utils.huggingface.html#_create_dataset_card

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._parse_split_kwargs

fiftyone.utils.huggingface.html#_parse_split_kwargs

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._parse_subset_kwargs

fiftyone.utils.huggingface.html#_parse_subset_kwargs

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._count_samples

fiftyone.utils.huggingface.html#_count_samples

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._no_progress_bars

fiftyone.utils.huggingface.html#_no_progress_bars

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig

fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.html

Class

Class

PUBLIC

Config for a Hugging Face Hub dataset that is stored as parquet files.
fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.__init__

fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.media_type

fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.html#media_type

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig._build_name

fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.html#_build_name

Function

Method

PRIVATE

Undocumented
fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.name

fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.html#name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig._build_allowed_splits

fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.html#_build_allowed_splits

Function

Method

PRIVATE

Undocumented
fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig._allowed_splits

fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.html#_allowed_splits

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig._build_allowed_subsets

fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.html#_build_allowed_subsets

Function

Method

PRIVATE

Undocumented
fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig._allowed_subsets

fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.html#_allowed_subsets

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig._build_media_fields_dict

fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.html#_build_media_fields_dict

Function

Method

PRIVATE

Undocumented
fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.media_fields

fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.html#media_fields

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig._build_label_fields_dict

fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.html#_build_label_fields_dict

Function

Method

PRIVATE

Undocumented
fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.label_fields

fiftyone.utils.huggingface.HFHubParquetFilesDatasetConfig.html#label_fields

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.huggingface._parse_format_string

fiftyone.utils.huggingface.html#_parse_format_string

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._build_config

fiftyone.utils.huggingface.html#_build_config

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_headers

fiftyone.utils.huggingface.html#_get_headers

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_dataset_metadata

fiftyone.utils.huggingface.html#_get_dataset_metadata

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._ensure_dataset_compatibility

fiftyone.utils.huggingface.html#_ensure_dataset_compatibility

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_download_dir

fiftyone.utils.huggingface.html#_get_download_dir

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_split_subset_pairs

fiftyone.utils.huggingface.html#_get_split_subset_pairs

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._load_dataset_from_config

fiftyone.utils.huggingface.html#_load_dataset_from_config

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_allowed_splits

fiftyone.utils.huggingface.html#_get_allowed_splits

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_allowed_subsets

fiftyone.utils.huggingface.html#_get_allowed_subsets

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._is_valid_split_subset_pair

fiftyone.utils.huggingface.html#_is_valid_split_subset_pair

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_label_field_names_and_types

fiftyone.utils.huggingface.html#_get_label_field_names_and_types

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_parquet_dataset_features

fiftyone.utils.huggingface.html#_get_parquet_dataset_features

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_num_rows

fiftyone.utils.huggingface.html#_get_num_rows

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._build_rows_request_url

fiftyone.utils.huggingface.html#_build_rows_request_url

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_rows

fiftyone.utils.huggingface.html#_get_rows

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._download_image

fiftyone.utils.huggingface.html#_download_image

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._download_images

fiftyone.utils.huggingface.html#_download_images

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface.MediaFieldConverter

fiftyone.utils.huggingface.MediaFieldConverter.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.huggingface.MediaFieldConverter.__init__

fiftyone.utils.huggingface.MediaFieldConverter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.huggingface.MediaFieldConverter.media_field_key

fiftyone.utils.huggingface.MediaFieldConverter.html#media_field_key

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.huggingface.MediaFieldConverter.media_field_name

fiftyone.utils.huggingface.MediaFieldConverter.html#media_field_name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.huggingface.MediaFieldConverter.feature

fiftyone.utils.huggingface.MediaFieldConverter.html#feature

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.huggingface.MediaFieldConverter.download_dir

fiftyone.utils.huggingface.MediaFieldConverter.html#download_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.huggingface.MediaFieldConverter.convert_media_field

fiftyone.utils.huggingface.MediaFieldConverter.html#convert_media_field

Function

Method

PUBLIC

Undocumented
fiftyone.utils.huggingface._build_media_field_converter

fiftyone.utils.huggingface.html#_build_media_field_converter

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_image_shape

fiftyone.utils.huggingface.html#_get_image_shape

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_detection_label_field_name

fiftyone.utils.huggingface.html#_get_detection_label_field_name

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_bounding_box_field_name

fiftyone.utils.huggingface.html#_get_bounding_box_field_name

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._convert_bounding_box

fiftyone.utils.huggingface.html#_convert_bounding_box

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._build_label_field_converter

fiftyone.utils.huggingface.html#_build_label_field_converter

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._build_dtype_field_converter

fiftyone.utils.huggingface.html#_build_dtype_field_converter

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._build_parquet_to_fiftyone_conversion

fiftyone.utils.huggingface.html#_build_parquet_to_fiftyone_conversion

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._add_parquet_subset_to_dataset

fiftyone.utils.huggingface.html#_add_parquet_subset_to_dataset

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._configure_dataset_media_fields

fiftyone.utils.huggingface.html#_configure_dataset_media_fields

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._add_dataset_metadata

fiftyone.utils.huggingface.html#_add_dataset_metadata

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._resolve_dataset_name

fiftyone.utils.huggingface.html#_resolve_dataset_name

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_media_fields

fiftyone.utils.huggingface.html#_get_media_fields

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._get_files_to_download

fiftyone.utils.huggingface.html#_get_files_to_download

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._load_fiftyone_dataset_from_config

fiftyone.utils.huggingface.html#_load_fiftyone_dataset_from_config

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._download_files_in_batches

fiftyone.utils.huggingface.html#_download_files_in_batches

Function

Function

PRIVATE

Undocumented
fiftyone.utils.huggingface._load_parquet_files_dataset_from_config

fiftyone.utils.huggingface.html#_load_parquet_files_dataset_from_config

Function

Function

PRIVATE

Undocumented
fiftyone.utils.image.logger

fiftyone.utils.image.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.image.read

fiftyone.utils.image.html#read

Function

Function

PUBLIC

Reads the image from the given path as a numpy array.
fiftyone.utils.image.write

fiftyone.utils.image.html#write

Function

Function

PUBLIC

Writes image to file.
fiftyone.utils.image.reencode_images

fiftyone.utils.image.html#reencode_images

Function

Function

PUBLIC

Re-encodes the images in the sample collection to the given format.
fiftyone.utils.image.transform_images

fiftyone.utils.image.html#transform_images

Function

Function

PUBLIC

Transforms the images in the sample collection according to the provided parameters.
fiftyone.utils.image.reencode_image

fiftyone.utils.image.html#reencode_image

Function

Function

PUBLIC

Re-encodes the image to the format specified by the given output path.
fiftyone.utils.image.transform_image

fiftyone.utils.image.html#transform_image

Function

Function

PUBLIC

Transforms the image according to the provided parameters.
fiftyone.utils.image._transform_images

fiftyone.utils.image.html#_transform_images

Function

Function

PRIVATE

Undocumented
fiftyone.utils.image._transform_images_single

fiftyone.utils.image.html#_transform_images_single

Function

Function

PRIVATE

Undocumented
fiftyone.utils.image._transform_images_multi

fiftyone.utils.image.html#_transform_images_multi

Function

Function

PRIVATE

Undocumented
fiftyone.utils.image._do_transform

fiftyone.utils.image.html#_do_transform

Function

Function

PRIVATE

Undocumented
fiftyone.utils.image._transform_image

fiftyone.utils.image.html#_transform_image

Function

Function

PRIVATE

Undocumented
fiftyone.utils.image._parse_parameters

fiftyone.utils.image.html#_parse_parameters

Function

Function

PRIVATE

Undocumented
fiftyone.utils.image._parse_ext

fiftyone.utils.image.html#_parse_ext

Function

Function

PRIVATE

Undocumented
fiftyone.utils.image._get_outpath

fiftyone.utils.image.html#_get_outpath

Function

Function

PRIVATE

Undocumented
fiftyone.utils.imagenet._TRAIN_IMAGES_TAR

fiftyone.utils.imagenet.html#_TRAIN_IMAGES_TAR

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.imagenet._VAL_IMAGES_DIR

fiftyone.utils.imagenet.html#_VAL_IMAGES_DIR

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.imagenet._DEVKIT_TAR

fiftyone.utils.imagenet.html#_DEVKIT_TAR

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.imagenet.ensure_imagenet_manual_download

fiftyone.utils.imagenet.html#ensure_imagenet_manual_download

Function

Function

PUBLIC

Ensures that the ImageNet archive(s) for the requested split have been manually downloaded to the required locations.
fiftyone.utils.imagenet._ensure_archive

fiftyone.utils.imagenet.html#_ensure_archive

Function

Function

PRIVATE

Undocumented
fiftyone.utils.imagenet._raise_imagenet_error

fiftyone.utils.imagenet.html#_raise_imagenet_error

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou.sg

fiftyone.utils.iou.html#sg

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.iou.so

fiftyone.utils.iou.html#so

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.iou.compute_ious

fiftyone.utils.iou.html#compute_ious

Function

Function

PUBLIC

Computes the pairwise IoUs between the predicted and ground truth objects.
fiftyone.utils.iou.compute_segment_ious

fiftyone.utils.iou.html#compute_segment_ious

Function

Function

PUBLIC

Computes the pairwise IoUs between the predicted and ground truth temporal detections.
fiftyone.utils.iou.compute_max_ious

fiftyone.utils.iou.html#compute_max_ious

Function

Function

PUBLIC

Populates an attribute on each label in the given spatial field(s) that records the max IoU between the object and another object in the same sample/frame.
fiftyone.utils.iou.find_duplicates

fiftyone.utils.iou.html#find_duplicates

Function

Function

PUBLIC

Returns IDs of duplicate labels in the given field of the collection, as defined as labels with an IoU greater than a chosen threshold with another label in the field.
fiftyone.utils.iou._compute_max_ious

fiftyone.utils.iou.html#_compute_max_ious

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._get_labels

fiftyone.utils.iou.html#_get_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._extract_max_ious

fiftyone.utils.iou.html#_extract_max_ious

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._find_duplicates

fiftyone.utils.iou.html#_find_duplicates

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._find_duplicates_simple

fiftyone.utils.iou.html#_find_duplicates_simple

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._find_duplicates_greedy

fiftyone.utils.iou.html#_find_duplicates_greedy

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._get_bbox_dim

fiftyone.utils.iou.html#_get_bbox_dim

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou.compute_bbox_iou

fiftyone.utils.iou.html#compute_bbox_iou

Function

Function

PUBLIC

Computes the IoU between the given ground truth and predicted detections.
fiftyone.utils.iou._get_detection_box

fiftyone.utils.iou.html#_get_detection_box

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._get_poly_box

fiftyone.utils.iou.html#_get_poly_box

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._compute_bbox_ious

fiftyone.utils.iou.html#_compute_bbox_ious

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._compute_polygon_ious

fiftyone.utils.iou.html#_compute_polygon_ious

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._compute_polyline_similarities

fiftyone.utils.iou.html#_compute_polyline_similarities

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._compute_mask_ious

fiftyone.utils.iou.html#_compute_mask_ious

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._compute_segment_ious

fiftyone.utils.iou.html#_compute_segment_ious

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._compute_keypoint_similarities

fiftyone.utils.iou.html#_compute_keypoint_similarities

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._compute_object_keypoint_similarity

fiftyone.utils.iou.html#_compute_object_keypoint_similarity

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._polylines_to_detections

fiftyone.utils.iou.html#_polylines_to_detections

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._masks_to_polylines

fiftyone.utils.iou.html#_masks_to_polylines

Function

Function

PRIVATE

Undocumented
fiftyone.utils.iou._polylines_to_shapely

fiftyone.utils.iou.html#_polylines_to_shapely

Function

Function

PRIVATE

Undocumented
fiftyone.utils.kinetics.logger

fiftyone.utils.kinetics.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.download_kinetics_split

fiftyone.utils.kinetics.html#download_kinetics_split

Function

Function

PUBLIC

Utility that downloads full or partial splits of the Kinetics dataset.
fiftyone.utils.kinetics.KineticsDatasetManager

fiftyone.utils.kinetics.KineticsDatasetManager.html

Class

Class

PUBLIC

Class that manages the sample IDs and labels that need to be downloaded as well as performing the actual downloading.
fiftyone.utils.kinetics.KineticsDatasetManager.__init__

fiftyone.utils.kinetics.KineticsDatasetManager.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetManager.info

fiftyone.utils.kinetics.KineticsDatasetManager.html#info

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetManager.download

fiftyone.utils.kinetics.KineticsDatasetManager.html#download

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetManager.download_partial_split

fiftyone.utils.kinetics.KineticsDatasetManager.html#download_partial_split

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetManager._download_entire_classes

fiftyone.utils.kinetics.KineticsDatasetManager.html#_download_entire_classes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetManager._download_samples_from_youtube

fiftyone.utils.kinetics.KineticsDatasetManager.html#_download_samples_from_youtube

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetManager._get_matching_samples

fiftyone.utils.kinetics.KineticsDatasetManager.html#_get_matching_samples

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetManager._get_all_matching_urls

fiftyone.utils.kinetics.KineticsDatasetManager.html#_get_all_matching_urls

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetManager._get_remaining_ids

fiftyone.utils.kinetics.KineticsDatasetManager.html#_get_remaining_ids

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetManager._log_loaded_tars

fiftyone.utils.kinetics.KineticsDatasetManager.html#_log_loaded_tars

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetManager._merge_and_write_errors

fiftyone.utils.kinetics.KineticsDatasetManager.html#_merge_and_write_errors

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetDownloader

fiftyone.utils.kinetics.KineticsDatasetDownloader.html

Class

Class

PUBLIC

Clas that downloads and extracts Kinetics tars from AWS.
fiftyone.utils.kinetics.KineticsDatasetDownloader.__init__

fiftyone.utils.kinetics.KineticsDatasetDownloader.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetDownloader.num_workers

fiftyone.utils.kinetics.KineticsDatasetDownloader.html#num_workers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetDownloader.download_entire_split

fiftyone.utils.kinetics.KineticsDatasetDownloader.html#download_entire_split

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetDownloader._process_split_tars

fiftyone.utils.kinetics.KineticsDatasetDownloader.html#_process_split_tars

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetDownloader._process_multisplit_tars

fiftyone.utils.kinetics.KineticsDatasetDownloader.html#_process_multisplit_tars

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetDownloader.download_classes

fiftyone.utils.kinetics.KineticsDatasetDownloader.html#download_classes

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetDownloader._download_tars

fiftyone.utils.kinetics.KineticsDatasetDownloader.html#_download_tars

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetDownloader._process_tars

fiftyone.utils.kinetics.KineticsDatasetDownloader.html#_process_tars

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetDownloader._process_class_tars

fiftyone.utils.kinetics.KineticsDatasetDownloader.html#_process_class_tars

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDownloadConfig

fiftyone.utils.kinetics.KineticsDownloadConfig.html

Class

Class

PUBLIC

Config class for a Kinetics download run.
fiftyone.utils.kinetics.KineticsDownloadConfig.__init__

fiftyone.utils.kinetics.KineticsDownloadConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDownloadConfig.split

fiftyone.utils.kinetics.KineticsDownloadConfig.html#split

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDownloadConfig.classes

fiftyone.utils.kinetics.KineticsDownloadConfig.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDownloadConfig.num_workers

fiftyone.utils.kinetics.KineticsDownloadConfig.html#num_workers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDownloadConfig.shuffle

fiftyone.utils.kinetics.KineticsDownloadConfig.html#shuffle

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDownloadConfig.seed

fiftyone.utils.kinetics.KineticsDownloadConfig.html#seed

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDownloadConfig.max_samples

fiftyone.utils.kinetics.KineticsDownloadConfig.html#max_samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDownloadConfig.retry_errors

fiftyone.utils.kinetics.KineticsDownloadConfig.html#retry_errors

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDownloadConfig.load_entire_split

fiftyone.utils.kinetics.KineticsDownloadConfig.html#load_entire_split

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDownloadConfig.validate

fiftyone.utils.kinetics.KineticsDownloadConfig.html#validate

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDownloadConfig.validate_split

fiftyone.utils.kinetics.KineticsDownloadConfig.html#validate_split

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo

fiftyone.utils.kinetics.KineticsDatasetInfo.html

Class

Class

PUBLIC

Class that contains information such as paths, labels, and sample IDs for a Kinetics download.
fiftyone.utils.kinetics.KineticsDatasetInfo.__init__

fiftyone.utils.kinetics.KineticsDatasetInfo.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.kinetics_dir

fiftyone.utils.kinetics.KineticsDatasetInfo.html#kinetics_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.scratch_dir

fiftyone.utils.kinetics.KineticsDatasetInfo.html#scratch_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.split

fiftyone.utils.kinetics.KineticsDatasetInfo.html#split

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.raw_annotations

fiftyone.utils.kinetics.KineticsDatasetInfo.html#raw_annotations

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo._classwise_sample_ids

fiftyone.utils.kinetics.KineticsDatasetInfo.html#_classwise_sample_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo._classwise_sample_ids_rev

fiftyone.utils.kinetics.KineticsDatasetInfo.html#_classwise_sample_ids_rev

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo._url_id_map

fiftyone.utils.kinetics.KineticsDatasetInfo.html#_url_id_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.all_classes

fiftyone.utils.kinetics.KineticsDatasetInfo.html#all_classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.all_sample_ids

fiftyone.utils.kinetics.KineticsDatasetInfo.html#all_sample_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.all_prev_loaded_tars

fiftyone.utils.kinetics.KineticsDatasetInfo.html#all_prev_loaded_tars

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.all_prev_errors

fiftyone.utils.kinetics.KineticsDatasetInfo.html#all_prev_errors

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.download_urls

fiftyone.utils.kinetics.KineticsDatasetInfo.html#download_urls

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.splits

fiftyone.utils.kinetics.KineticsDatasetInfo.html#splits

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.version

fiftyone.utils.kinetics.KineticsDatasetInfo.html#version

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.supports_classwise_s3_downloads

fiftyone.utils.kinetics.KineticsDatasetInfo.html#supports_classwise_s3_downloads

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.raw_dir

fiftyone.utils.kinetics.KineticsDatasetInfo.html#raw_dir

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.raw_anno_path

fiftyone.utils.kinetics.KineticsDatasetInfo.html#raw_anno_path

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.raw_anno_path_split

fiftyone.utils.kinetics.KineticsDatasetInfo.html#raw_anno_path_split

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.urls_s3_file

fiftyone.utils.kinetics.KineticsDatasetInfo.html#urls_s3_file

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.urls_filename

fiftyone.utils.kinetics.KineticsDatasetInfo.html#urls_filename

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.urls_path

fiftyone.utils.kinetics.KineticsDatasetInfo.html#urls_path

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.error_path

fiftyone.utils.kinetics.KineticsDatasetInfo.html#error_path

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.prev_errors

fiftyone.utils.kinetics.KineticsDatasetInfo.html#prev_errors

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.loaded_tar_path

fiftyone.utils.kinetics.KineticsDatasetInfo.html#loaded_tar_path

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.prev_loaded_tars

fiftyone.utils.kinetics.KineticsDatasetInfo.html#prev_loaded_tars

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.multisplit_urls

fiftyone.utils.kinetics.KineticsDatasetInfo.html#multisplit_urls

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.split_dir

fiftyone.utils.kinetics.KineticsDatasetInfo.html#split_dir

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.class_dir

fiftyone.utils.kinetics.KineticsDatasetInfo.html#class_dir

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.class_existing_sample_ids

fiftyone.utils.kinetics.KineticsDatasetInfo.html#class_existing_sample_ids

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.class_sample_ids

fiftyone.utils.kinetics.KineticsDatasetInfo.html#class_sample_ids

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.id_from_filename

fiftyone.utils.kinetics.KineticsDatasetInfo.html#id_from_filename

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.filename_from_id

fiftyone.utils.kinetics.KineticsDatasetInfo.html#filename_from_id

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.segment_from_id

fiftyone.utils.kinetics.KineticsDatasetInfo.html#segment_from_id

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.url_from_id

fiftyone.utils.kinetics.KineticsDatasetInfo.html#url_from_id

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.id_from_url

fiftyone.utils.kinetics.KineticsDatasetInfo.html#id_from_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.get_video_class

fiftyone.utils.kinetics.KineticsDatasetInfo.html#get_video_class

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.cleanup_partial_downloads

fiftyone.utils.kinetics.KineticsDatasetInfo.html#cleanup_partial_downloads

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.cleanup_excess_videos

fiftyone.utils.kinetics.KineticsDatasetInfo.html#cleanup_excess_videos

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.update_existing_sample_ids

fiftyone.utils.kinetics.KineticsDatasetInfo.html#update_existing_sample_ids

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo._classwise_existing_sample_ids

fiftyone.utils.kinetics.KineticsDatasetInfo.html#_classwise_existing_sample_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.existing_sample_ids

fiftyone.utils.kinetics.KineticsDatasetInfo.html#existing_sample_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.get_incomplete_classes

fiftyone.utils.kinetics.KineticsDatasetInfo.html#get_incomplete_classes

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.validate_classes

fiftyone.utils.kinetics.KineticsDatasetInfo.html#validate_classes

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo._get_download_urls

fiftyone.utils.kinetics.KineticsDatasetInfo.html#_get_download_urls

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo._get_split_download_urls

fiftyone.utils.kinetics.KineticsDatasetInfo.html#_get_split_download_urls

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo._get_raw_annotations

fiftyone.utils.kinetics.KineticsDatasetInfo.html#_get_raw_annotations

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo._parse_sample_ids

fiftyone.utils.kinetics.KineticsDatasetInfo.html#_parse_sample_ids

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo._get_video_files

fiftyone.utils.kinetics.KineticsDatasetInfo.html#_get_video_files

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo._get_prev_loaded_tars

fiftyone.utils.kinetics.KineticsDatasetInfo.html#_get_prev_loaded_tars

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo._get_prev_errors

fiftyone.utils.kinetics.KineticsDatasetInfo.html#_get_prev_errors

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.get_kinetics_dir

fiftyone.utils.kinetics.KineticsDatasetInfo.html#get_kinetics_dir

Function

Class Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.KineticsDatasetInfo.build_for_version

fiftyone.utils.kinetics.KineticsDatasetInfo.html#build_for_version

Function

Class Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.Kinetics400DatasetInfo

fiftyone.utils.kinetics.Kinetics400DatasetInfo.html

Class

Class

PUBLIC

Kinetics 400-specific dataset info.
fiftyone.utils.kinetics.Kinetics400DatasetInfo.supports_classwise_s3_downloads

fiftyone.utils.kinetics.Kinetics400DatasetInfo.html#supports_classwise_s3_downloads

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.Kinetics400DatasetInfo.version

fiftyone.utils.kinetics.Kinetics400DatasetInfo.html#version

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.Kinetics400DatasetInfo.multisplit_urls

fiftyone.utils.kinetics.Kinetics400DatasetInfo.html#multisplit_urls

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.Kinetics400DatasetInfo._get_download_urls

fiftyone.utils.kinetics.Kinetics400DatasetInfo.html#_get_download_urls

Function

Method

PRIVATE

Undocumented
fiftyone.utils.kinetics.ClasswiseS3KineticsDatasetInfo

fiftyone.utils.kinetics.ClasswiseS3KineticsDatasetInfo.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.kinetics.ClasswiseS3KineticsDatasetInfo.supports_classwise_s3_downloads

fiftyone.utils.kinetics.ClasswiseS3KineticsDatasetInfo.html#supports_classwise_s3_downloads

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.ClasswiseS3KineticsDatasetInfo.class_url

fiftyone.utils.kinetics.ClasswiseS3KineticsDatasetInfo.html#class_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.ClasswiseS3KineticsDatasetInfo.unloaded_class_urls

fiftyone.utils.kinetics.ClasswiseS3KineticsDatasetInfo.html#unloaded_class_urls

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.Kinetics600DatasetInfo

fiftyone.utils.kinetics.Kinetics600DatasetInfo.html

Class

Class

PUBLIC

Kinetics 600-specific dataset info.
fiftyone.utils.kinetics.Kinetics600DatasetInfo.version

fiftyone.utils.kinetics.Kinetics600DatasetInfo.html#version

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.Kinetics7002020DatasetInfo

fiftyone.utils.kinetics.Kinetics7002020DatasetInfo.html

Class

Class

PUBLIC

Kinetics 700-2020-specific dataset info.
fiftyone.utils.kinetics.Kinetics7002020DatasetInfo.version

fiftyone.utils.kinetics.Kinetics7002020DatasetInfo.html#version

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.Kinetics7002020DatasetInfo.class_url

fiftyone.utils.kinetics.Kinetics7002020DatasetInfo.html#class_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kinetics.Kinetics700DatasetInfo

fiftyone.utils.kinetics.Kinetics700DatasetInfo.html

Class

Class

PUBLIC

Kinetics 700-specific dataset info.
fiftyone.utils.kinetics.Kinetics700DatasetInfo.version

fiftyone.utils.kinetics.Kinetics700DatasetInfo.html#version

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics.Kinetics700DatasetInfo.urls_s3_file

fiftyone.utils.kinetics.Kinetics700DatasetInfo.html#urls_s3_file

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.kinetics._flatten_list

fiftyone.utils.kinetics.html#_flatten_list

Function

Function

PRIVATE

Undocumented
fiftyone.utils.kinetics._INFO_VERSION_MAP

fiftyone.utils.kinetics.html#_INFO_VERSION_MAP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.kinetics._ANNOTATION_DOWNLOAD_LINKS

fiftyone.utils.kinetics.html#_ANNOTATION_DOWNLOAD_LINKS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.kinetics._SPLIT_MAP

fiftyone.utils.kinetics.html#_SPLIT_MAP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.kitti.o3d

fiftyone.utils.kitti.html#o3d

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.kitti.logger

fiftyone.utils.kitti.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetImporter

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html

Class

Class

PUBLIC

Importer for KITTI detection datasets stored on disk.
fiftyone.utils.kitti.KITTIDetectionDatasetImporter.data_path

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetImporter.labels_path

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetImporter.include_all_data

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#include_all_data

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetImporter.extra_attrs

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#extra_attrs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetImporter.__init__

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetImporter._image_paths_map

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#_image_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetImporter._labels_paths_map

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#_labels_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetImporter._uuids

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetImporter._iter_uuids

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#_iter_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetImporter._num_samples

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetImporter.__iter__

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetImporter.__len__

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.kitti.KITTIDetectionDatasetImporter.__next__

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.kitti.KITTIDetectionDatasetImporter.has_dataset_info

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.kitti.KITTIDetectionDatasetImporter.has_image_metadata

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.kitti.KITTIDetectionDatasetImporter.label_cls

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.kitti.KITTIDetectionDatasetImporter.setup

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.kitti.KITTIDetectionDatasetImporter._get_num_samples

fiftyone.utils.kitti.KITTIDetectionDatasetImporter.html#_get_num_samples

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetExporter

fiftyone.utils.kitti.KITTIDetectionDatasetExporter.html

Class

Class

PUBLIC

Exporter that writes KITTI detection datasets to disk.
fiftyone.utils.kitti.KITTIDetectionDatasetExporter.data_path

fiftyone.utils.kitti.KITTIDetectionDatasetExporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetExporter.labels_path

fiftyone.utils.kitti.KITTIDetectionDatasetExporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetExporter.export_media

fiftyone.utils.kitti.KITTIDetectionDatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetExporter.rel_dir

fiftyone.utils.kitti.KITTIDetectionDatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetExporter.image_format

fiftyone.utils.kitti.KITTIDetectionDatasetExporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetExporter.__init__

fiftyone.utils.kitti.KITTIDetectionDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetExporter._writer

fiftyone.utils.kitti.KITTIDetectionDatasetExporter.html#_writer

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetExporter._media_exporter

fiftyone.utils.kitti.KITTIDetectionDatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.kitti.KITTIDetectionDatasetExporter.requires_image_metadata

fiftyone.utils.kitti.KITTIDetectionDatasetExporter.html#requires_image_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.
fiftyone.utils.kitti.KITTIDetectionDatasetExporter.label_cls

fiftyone.utils.kitti.KITTIDetectionDatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) exported by this exporter.
fiftyone.utils.kitti.KITTIDetectionDatasetExporter.setup

fiftyone.utils.kitti.KITTIDetectionDatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.kitti.KITTIDetectionDatasetExporter.export_sample

fiftyone.utils.kitti.KITTIDetectionDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.kitti.KITTIDetectionDatasetExporter.close

fiftyone.utils.kitti.KITTIDetectionDatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.kitti.KITTIAnnotationWriter

fiftyone.utils.kitti.KITTIAnnotationWriter.html

Class

Class

PUBLIC

Class for writing annotations in KITTI detection format.
fiftyone.utils.kitti.KITTIAnnotationWriter.write

fiftyone.utils.kitti.KITTIAnnotationWriter.html#write

Function

Method

PUBLIC

Writes the detections to disk.
fiftyone.utils.kitti.load_kitti_detection_annotations

fiftyone.utils.kitti.html#load_kitti_detection_annotations

Function

Function

PUBLIC

Loads the KITTI detection annotations from the given TXT file.
fiftyone.utils.kitti.download_kitti_multiview_dataset

fiftyone.utils.kitti.html#download_kitti_multiview_dataset

Function

Function

PUBLIC

Downloads and prepares the multiview KITTI dataset.
fiftyone.utils.kitti.download_kitti_detection_dataset

fiftyone.utils.kitti.html#download_kitti_detection_dataset

Function

Function

PUBLIC

Downloads the KITTI object detection dataset from the web.
fiftyone.utils.kitti._LABELS

fiftyone.utils.kitti.html#_LABELS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.kitti._LEFT_IMAGES

fiftyone.utils.kitti.html#_LEFT_IMAGES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.kitti._RIGHT_IMAGES

fiftyone.utils.kitti.html#_RIGHT_IMAGES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.kitti._VELODYNE

fiftyone.utils.kitti.html#_VELODYNE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.kitti._CALIB

fiftyone.utils.kitti.html#_CALIB

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.kitti._download_and_unpack_kitti_zip

fiftyone.utils.kitti.html#_download_and_unpack_kitti_zip

Function

Function

PRIVATE

Undocumented
fiftyone.utils.kitti._parse_kitti_detection_row

fiftyone.utils.kitti.html#_parse_kitti_detection_row

Function

Function

PRIVATE

Undocumented
fiftyone.utils.kitti._make_kitti_detection_row

fiftyone.utils.kitti.html#_make_kitti_detection_row

Function

Function

PRIVATE

Undocumented
fiftyone.utils.kitti._prepare_kitti_split

fiftyone.utils.kitti.html#_prepare_kitti_split

Function

Function

PRIVATE

Undocumented
fiftyone.utils.kitti._load_kitti_annotations

fiftyone.utils.kitti.html#_load_kitti_annotations

Function

Function

PRIVATE

Undocumented
fiftyone.utils.kitti._normalize_3d_detections

fiftyone.utils.kitti.html#_normalize_3d_detections

Function

Function

PRIVATE

Undocumented
fiftyone.utils.kitti._swap_coordinates

fiftyone.utils.kitti.html#_swap_coordinates

Function

Function

PRIVATE

Undocumented
fiftyone.utils.kitti._load_calibration_matrices

fiftyone.utils.kitti.html#_load_calibration_matrices

Function

Function

PRIVATE

Undocumented
fiftyone.utils.kitti._roty

fiftyone.utils.kitti.html#_roty

Function

Function

PRIVATE

Undocumented
fiftyone.utils.kitti._proj_3d_to_right_camera

fiftyone.utils.kitti.html#_proj_3d_to_right_camera

Function

Function

PRIVATE

Undocumented
fiftyone.utils.kitti._convert_velodyne_to_pcd

fiftyone.utils.kitti.html#_convert_velodyne_to_pcd

Function

Function

PRIVATE

Undocumented
fiftyone.utils.kitti._do_conversion

fiftyone.utils.kitti.html#_do_conversion

Function

Function

PRIVATE

Undocumented
fiftyone.utils.kitti._write_fo3d_files

fiftyone.utils.kitti.html#_write_fo3d_files

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelbox.lb

fiftyone.utils.labelbox.html#lb

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.labelbox.lbs

fiftyone.utils.labelbox.html#lbs

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.labelbox.lbo

fiftyone.utils.labelbox.html#lbo

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.labelbox.lbr

fiftyone.utils.labelbox.html#lbr

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.labelbox.logger

fiftyone.utils.labelbox.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxExportVersion

fiftyone.utils.labelbox.LabelboxExportVersion.html

Class

Class

PUBLIC

Enum for Labelbox export formats and API versions.
fiftyone.utils.labelbox.LabelboxExportVersion.V1

fiftyone.utils.labelbox.LabelboxExportVersion.html#V1

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxExportVersion.V2

fiftyone.utils.labelbox.LabelboxExportVersion.html#V2

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxBackendConfig

fiftyone.utils.labelbox.LabelboxBackendConfig.html

Class

Class

PUBLIC

Class for configuring LabelboxBackend instances.
fiftyone.utils.labelbox.LabelboxBackendConfig.url

fiftyone.utils.labelbox.LabelboxBackendConfig.html#url

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxBackendConfig.project_name

fiftyone.utils.labelbox.LabelboxBackendConfig.html#project_name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxBackendConfig.members

fiftyone.utils.labelbox.LabelboxBackendConfig.html#members

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxBackendConfig.classes_as_attrs

fiftyone.utils.labelbox.LabelboxBackendConfig.html#classes_as_attrs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxBackendConfig.export_version

fiftyone.utils.labelbox.LabelboxBackendConfig.html#export_version

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxBackendConfig.__init__

fiftyone.utils.labelbox.LabelboxBackendConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxBackendConfig._api_key

fiftyone.utils.labelbox.LabelboxBackendConfig.html#_api_key

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxBackendConfig.api_key

fiftyone.utils.labelbox.LabelboxBackendConfig.html#api_key

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxBackendConfig.api_key.setter

fiftyone.utils.labelbox.LabelboxBackendConfig.html#api_key.setter

Function

Method

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxBackendConfig._experimental

fiftyone.utils.labelbox.LabelboxBackendConfig.html#_experimental

Attribute

Property

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxBackendConfig.load_credentials

fiftyone.utils.labelbox.LabelboxBackendConfig.html#load_credentials

Function

Method

PUBLIC

Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config.
fiftyone.utils.labelbox.LabelboxBackend

fiftyone.utils.labelbox.LabelboxBackend.html

Class

Class

PUBLIC

Class for interacting with the Labelbox annotation backend.
fiftyone.utils.labelbox.LabelboxBackend.supported_media_types

fiftyone.utils.labelbox.LabelboxBackend.html#supported_media_types

Attribute

Property

PUBLIC

The list of media types that this backend supports.
fiftyone.utils.labelbox.LabelboxBackend.supported_label_types

fiftyone.utils.labelbox.LabelboxBackend.html#supported_label_types

Attribute

Property

PUBLIC

The list of label types supported by the backend.
fiftyone.utils.labelbox.LabelboxBackend.supported_scalar_types

fiftyone.utils.labelbox.LabelboxBackend.html#supported_scalar_types

Attribute

Property

PUBLIC

The list of scalar field types supported by the backend.
fiftyone.utils.labelbox.LabelboxBackend.supported_attr_types

fiftyone.utils.labelbox.LabelboxBackend.html#supported_attr_types

Attribute

Property

PUBLIC

The list of attribute types supported by the backend.
fiftyone.utils.labelbox.LabelboxBackend.supports_keyframes

fiftyone.utils.labelbox.LabelboxBackend.html#supports_keyframes

Attribute

Property

PUBLIC

Whether this backend supports uploading only keyframes when editing existing video track annotations.
fiftyone.utils.labelbox.LabelboxBackend.supports_video_sample_fields

fiftyone.utils.labelbox.LabelboxBackend.html#supports_video_sample_fields

Attribute

Property

PUBLIC

Whether this backend supports annotating video labels at a sample-level.
fiftyone.utils.labelbox.LabelboxBackend.requires_label_schema

fiftyone.utils.labelbox.LabelboxBackend.html#requires_label_schema

Attribute

Property

PUBLIC

Whether this backend requires a pre-defined label schema for its annotation runs.
fiftyone.utils.labelbox.LabelboxBackend.recommend_attr_tool

fiftyone.utils.labelbox.LabelboxBackend.html#recommend_attr_tool

Function

Method

PUBLIC

Recommends an attribute tool for an attribute with the given name and value.
fiftyone.utils.labelbox.LabelboxBackend.requires_attr_values

fiftyone.utils.labelbox.LabelboxBackend.html#requires_attr_values

Function

Method

PUBLIC

Determines whether the list of possible values are required for attributes of the given type.
fiftyone.utils.labelbox.LabelboxBackend._connect_to_api

fiftyone.utils.labelbox.LabelboxBackend.html#_connect_to_api

Function

Method

PRIVATE

Returns a new API instance connected to the annotation backend.
fiftyone.utils.labelbox.LabelboxBackend.upload_annotations

fiftyone.utils.labelbox.LabelboxBackend.html#upload_annotations

Function

Method

PUBLIC

Uploads the samples and relevant existing labels from the label schema to the annotation backend.
fiftyone.utils.labelbox.LabelboxBackend.download_annotations

fiftyone.utils.labelbox.LabelboxBackend.html#download_annotations

Function

Method

PUBLIC

Downloads the annotations from the annotation backend for the given results.
fiftyone.utils.labelbox.LabelboxAnnotationAPI

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html

Class

Class

PUBLIC

A class to facilitate connection to and management of projects in Labelbox.
fiftyone.utils.labelbox.LabelboxAnnotationAPI.export_version

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#export_version

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI.__init__

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._name

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_name

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._url

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_url

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._protocol

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_protocol

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._api_key

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_api_key

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._experimental

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_experimental

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._roles

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_roles

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._tool_types_map

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_tool_types_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._setup

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_setup

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._client

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_client

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._LabelboxExportToFiftyOneConverter

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_LabelboxExportToFiftyOneConverter

Attribute

Property

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI.roles

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#roles

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI.attr_type_map

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#attr_type_map

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI.attr_list_types

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#attr_list_types

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI.base_api_url

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#base_api_url

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI.base_graphql_url

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#base_graphql_url

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI.projects_url

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#projects_url

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI.project_url

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#project_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI.editor_url

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#editor_url

Function

Method

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI.get_project_users

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#get_project_users

Function

Method

PUBLIC

Returns a list of users that are assigned to the given project.
fiftyone.utils.labelbox.LabelboxAnnotationAPI.add_member

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#add_member

Function

Method

PUBLIC

Adds a member to the given Labelbox project with the given project-level role.
fiftyone.utils.labelbox.LabelboxAnnotationAPI.list_datasets

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#list_datasets

Function

Method

PUBLIC

Retrieves the list of datasets in your Labelbox account.
fiftyone.utils.labelbox.LabelboxAnnotationAPI.delete_datasets

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#delete_datasets

Function

Method

PUBLIC

Deletes the given datasets from the Labelbox server.
fiftyone.utils.labelbox.LabelboxAnnotationAPI.list_projects

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#list_projects

Function

Method

PUBLIC

Retrieves the list of projects in your Labelbox account.
fiftyone.utils.labelbox.LabelboxAnnotationAPI.get_project

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#get_project

Function

Method

PUBLIC

Retrieves the labelbox.schema.project.Project for the project with the given ID.
fiftyone.utils.labelbox.LabelboxAnnotationAPI.delete_project

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#delete_project

Function

Method

PUBLIC

Deletes the given project from the Labelbox server.
fiftyone.utils.labelbox.LabelboxAnnotationAPI.delete_projects

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#delete_projects

Function

Method

PUBLIC

Deletes the given projects from the Labelbox server.
fiftyone.utils.labelbox.LabelboxAnnotationAPI.delete_unused_ontologies

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#delete_unused_ontologies

Function

Method

PUBLIC

Deletes unused ontologies from the Labelbox server.
fiftyone.utils.labelbox.LabelboxAnnotationAPI.launch_editor

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#launch_editor

Function

Method

PUBLIC

Launches the Labelbox editor in your default web browser.
fiftyone.utils.labelbox.LabelboxAnnotationAPI._skip_existing_global_keys

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_skip_existing_global_keys

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI.upload_data

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#upload_data

Function

Method

PUBLIC

Uploads the media for the given samples to Labelbox.
fiftyone.utils.labelbox.LabelboxAnnotationAPI.upload_samples

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#upload_samples

Function

Method

PUBLIC

Uploads the given samples to Labelbox according to the given backend's annotation and server configuration.
fiftyone.utils.labelbox.LabelboxAnnotationAPI.get_data_row_ids

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#get_data_row_ids

Function

Method

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI.download_annotations

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#download_annotations

Function

Method

PUBLIC

Downloads the annotations from the Labelbox server for the given results instance and parses them into the appropriate FiftyOne types.
fiftyone.utils.labelbox.LabelboxAnnotationAPI._process_label_fields

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_process_label_fields

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._build_frame_id_map

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_build_frame_id_map

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._setup_project

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_setup_project

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._setup_editor

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_setup_editor

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._create_ontology_tools

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_create_ontology_tools

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._build_attributes

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_build_attributes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._build_classifications

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_build_classifications

Function

Method

PRIVATE

Returns the classifications for the given label field. Generally, the classification is a dropdown selection for given classes, but can be a text entry for scalars without provided classes.
fiftyone.utils.labelbox.LabelboxAnnotationAPI._build_tools

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_build_tools

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._build_tool_for_class

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_build_tool_for_class

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._create_classes_as_attrs

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_create_classes_as_attrs

Function

Method

PRIVATE

Creates radio attributes for all classes and formats all class-specific attributes.
fiftyone.utils.labelbox.LabelboxAnnotationAPI._get_sample_metadata

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_get_sample_metadata

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._get_video_labels

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_get_video_labels

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._download_project_labels

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_download_project_labels

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._add_labels_to_results

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_add_labels_to_results

Function

Method

PRIVATE

Adds the labels in labels_dict to results.
fiftyone.utils.labelbox.LabelboxAnnotationAPI._add_video_labels_to_results

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_add_video_labels_to_results

Function

Method

PRIVATE

Adds the video labels in frames_dict to results.
fiftyone.utils.labelbox.LabelboxAnnotationAPI._gather_classification_attributes

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_gather_classification_attributes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._parse_expected_label_fields

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_parse_expected_label_fields

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._convert_label_types

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_convert_label_types

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._convert_segmentations

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_convert_segmentations

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationAPI._merge_results

fiftyone.utils.labelbox.LabelboxAnnotationAPI.html#_merge_results

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationResults

fiftyone.utils.labelbox.LabelboxAnnotationResults.html

Class

Class

PUBLIC

Class that stores all relevant information needed to monitor the progress of an annotation run sent to Labelbox and download the results.
fiftyone.utils.labelbox.LabelboxAnnotationResults.__init__

fiftyone.utils.labelbox.LabelboxAnnotationResults.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationResults.project_id

fiftyone.utils.labelbox.LabelboxAnnotationResults.html#project_id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationResults.frame_id_map

fiftyone.utils.labelbox.LabelboxAnnotationResults.html#frame_id_map

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationResults.launch_editor

fiftyone.utils.labelbox.LabelboxAnnotationResults.html#launch_editor

Function

Method

PUBLIC

Launches the Labelbox editor and loads the project for this annotation run.
fiftyone.utils.labelbox.LabelboxAnnotationResults.get_status

fiftyone.utils.labelbox.LabelboxAnnotationResults.html#get_status

Function

Method

PUBLIC

Gets the status of the annotation run.
fiftyone.utils.labelbox.LabelboxAnnotationResults.print_status

fiftyone.utils.labelbox.LabelboxAnnotationResults.html#print_status

Function

Method

PUBLIC

Prints the status of the annotation run.
fiftyone.utils.labelbox.LabelboxAnnotationResults.cleanup

fiftyone.utils.labelbox.LabelboxAnnotationResults.html#cleanup

Function

Method

PUBLIC

Deletes the project associated with this annotation run from the Labelbox server.
fiftyone.utils.labelbox.LabelboxAnnotationResults._get_status

fiftyone.utils.labelbox.LabelboxAnnotationResults.html#_get_status

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox.LabelboxAnnotationResults._from_dict

fiftyone.utils.labelbox.LabelboxAnnotationResults.html#_from_dict

Function

Class Method

PRIVATE

Builds an AnnotationResults from a JSON dict representation of it.
fiftyone.utils.labelbox._warn_labelbox_v1

fiftyone.utils.labelbox.html#_warn_labelbox_v1

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelbox.import_from_labelbox

fiftyone.utils.labelbox.html#import_from_labelbox

Function

Function

PUBLIC

Imports the labels from the Labelbox project into the FiftyOne dataset.
fiftyone.utils.labelbox.export_to_labelbox

fiftyone.utils.labelbox.html#export_to_labelbox

Function

Function

PUBLIC

Exports labels from the FiftyOne samples to Labelbox format.
fiftyone.utils.labelbox.download_labels_from_labelbox

fiftyone.utils.labelbox.html#download_labels_from_labelbox

Function

Function

PUBLIC

Downloads the labels for the given Labelbox project.
fiftyone.utils.labelbox._download_labels_from_labelbox_v1

fiftyone.utils.labelbox.html#_download_labels_from_labelbox_v1

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelbox.upload_media_to_labelbox

fiftyone.utils.labelbox.html#upload_media_to_labelbox

Function

Function

PUBLIC

Uploads the raw media for the FiftyOne samples to Labelbox.
fiftyone.utils.labelbox.upload_labels_to_labelbox

fiftyone.utils.labelbox.html#upload_labels_to_labelbox

Function

Function

PUBLIC

Uploads labels to a Labelbox project.
fiftyone.utils.labelbox.convert_labelbox_export_to_import

fiftyone.utils.labelbox.html#convert_labelbox_export_to_import

Function

Function

PUBLIC

Converts a Labelbox NDJSON export generated by export_to_labelbox into the format expected by import_from_labelbox.
fiftyone.utils.labelbox._convert_labelbox_frames_export_to_import

fiftyone.utils.labelbox.html#_convert_labelbox_frames_export_to_import

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelbox._ingest_label

fiftyone.utils.labelbox.html#_ingest_label

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelbox._get_labels

fiftyone.utils.labelbox.html#_get_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelbox._get_frame_labels

fiftyone.utils.labelbox.html#_get_frame_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase

fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase.html

Class

Class

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase._to_global_classification

fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase.html#_to_global_classification

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase._validate_label_class

fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase.html#_validate_label_class

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase._get_nested_classifications

fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase.html#_get_nested_classifications

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase._to_mask

fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase.html#_to_mask

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase._get_base_anno_name

fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase.html#_get_base_anno_name

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase._to_detections

fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase.html#_to_detections

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase._to_polylines

fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase.html#_to_polylines

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase._to_points

fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase.html#_to_points

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase._make_base_anno

fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase.html#_make_base_anno

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase._make_classification_answer

fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase.html#_make_classification_answer

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase._make_bbox

fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase.html#_make_bbox

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase._make_point

fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase.html#_make_point

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase._make_mask

fiftyone.utils.labelbox._FiftyOneToLabelboxConverterBase.html#_make_mask

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxExportConverterV1

fiftyone.utils.labelbox._FiftyOneToLabelboxExportConverterV1.html

Class

Class

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxExportConverterV1._to_labelbox_image_labels

fiftyone.utils.labelbox._FiftyOneToLabelboxExportConverterV1.html#_to_labelbox_image_labels

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._FiftyOneToLabelboxExportConverterV1._to_labelbox_video_labels

fiftyone.utils.labelbox._FiftyOneToLabelboxExportConverterV1.html#_to_labelbox_video_labels

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html

Class

Class

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._parse_video_labels

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_parse_video_labels

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._parse_image_labels

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_parse_image_labels

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._get_datarow_id

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_get_datarow_id

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._get_global_key

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_get_global_key

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._get_answer_value

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_get_answer_value

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._iter_video_labels

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_iter_video_labels

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._get_labels_dict

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_get_labels_dict

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._parse_classifications

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_parse_classifications

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._parse_attributes

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_parse_attributes

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._bounding_box_name

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_bounding_box_name

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._get_mask_url

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_get_mask_url

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._get_label_field_attr

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_get_label_field_attr

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._parse_objects

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_parse_objects

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._parse_bbox

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_parse_bbox

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._parse_points

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_parse_points

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._parse_point

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_parse_point

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1._parse_mask

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV1.html#_parse_mask

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2.html

Class

Class

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2._get_answer_value

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2.html#_get_answer_value

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2._get_datarow_id

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2.html#_get_datarow_id

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2._get_global_key

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2.html#_get_global_key

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2._iter_video_labels

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2.html#_iter_video_labels

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2._get_labels_dict

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2.html#_get_labels_dict

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2._parse_classifications

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2.html#_parse_classifications

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2._parse_attributes

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2.html#_parse_attributes

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2._bounding_box_name

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2.html#_bounding_box_name

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2._get_mask_url

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2.html#_get_mask_url

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2._get_label_field_attr

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2.html#_get_label_field_attr

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2._parse_mask

fiftyone.utils.labelbox._LabelboxExportToFiftyOneConverterV2.html#_parse_mask

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.labelbox._make_video_anno

fiftyone.utils.labelbox.html#_make_video_anno

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelbox._download_or_load_ndjson

fiftyone.utils.labelbox.html#_download_or_load_ndjson

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelbox._parse_attribute

fiftyone.utils.labelbox.html#_parse_attribute

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelbox._get_attr_type

fiftyone.utils.labelbox.html#_get_attr_type

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelbox._UNIQUE_TYPE_MAP

fiftyone.utils.labelbox.html#_UNIQUE_TYPE_MAP

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.labels.objects_to_segmentations

fiftyone.utils.labels.html#objects_to_segmentations

Function

Function

PUBLIC

Converts the instance segmentations or polylines in the specified field of the collection into semantic segmentation masks.
fiftyone.utils.labels.export_segmentations

fiftyone.utils.labels.html#export_segmentations

Function

Function

PUBLIC

Exports the semantic segmentations, instance segmentations, or heatmaps stored as in-database arrays in the specified field to images on disk.
fiftyone.utils.labels.import_segmentations

fiftyone.utils.labels.html#import_segmentations

Function

Function

PUBLIC

Imports the semantic segmentations, instance segmentations, or heatmaps stored on disk in the specified field to in-database arrays.
fiftyone.utils.labels.transform_segmentations

fiftyone.utils.labels.html#transform_segmentations

Function

Function

PUBLIC

Transforms the segmentations in the given field according to the provided targets map.
fiftyone.utils.labels._transform_mask_targets

fiftyone.utils.labels.html#_transform_mask_targets

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labels.segmentations_to_detections

fiftyone.utils.labels.html#segmentations_to_detections

Function

Function

PUBLIC

Converts the semantic segmentations masks in the specified field of the collection into fiftyone.core.labels.Detections with instance masks populated.
fiftyone.utils.labels.instances_to_polylines

fiftyone.utils.labels.html#instances_to_polylines

Function

Function

PUBLIC

Converts the instance segmentations in the specified field of the collection into fiftyone.core.labels.Polylines instances.
fiftyone.utils.labels.segmentations_to_polylines

fiftyone.utils.labels.html#segmentations_to_polylines

Function

Function

PUBLIC

Converts the semantic segmentations masks in the specified field of the collection into fiftyone.core.labels.Polylines instances.
fiftyone.utils.labels.classification_to_detections

fiftyone.utils.labels.html#classification_to_detections

Function

Function

PUBLIC

Converts the fiftyone.core.labels.Classification field of the collection into a fiftyone.core.labels.Detections field containing a single detection whose bounding box spans the entire image.
fiftyone.utils.labels.classifications_to_detections

fiftyone.utils.labels.html#classifications_to_detections

Function

Function

PUBLIC

Converts the fiftyone.core.labels.Classifications field of the collection into a fiftyone.core.labels.Detections field containing detections whose bounding boxes span the entire image with one detection for each classification.
fiftyone.utils.labels.perform_nms

fiftyone.utils.labels.html#perform_nms

Function

Function

PUBLIC

Performs non-maximum suppression (NMS) on the specified fiftyone.core.labels.Detections field.
fiftyone.utils.labels._perform_nms

fiftyone.utils.labels.html#_perform_nms

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio.ls

fiftyone.utils.labelstudio.html#ls

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.labelstudio.brush

fiftyone.utils.labelstudio.html#brush

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.labelstudio.etree

fiftyone.utils.labelstudio.html#etree

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.labelstudio.logger

fiftyone.utils.labelstudio.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.labelstudio.LabelStudioBackendConfig

fiftyone.utils.labelstudio.LabelStudioBackendConfig.html

Class

Class

PUBLIC

Class for configuring LabelStudioBackend instances.
fiftyone.utils.labelstudio.LabelStudioBackendConfig.url

fiftyone.utils.labelstudio.LabelStudioBackendConfig.html#url

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.labelstudio.LabelStudioBackendConfig.project_name

fiftyone.utils.labelstudio.LabelStudioBackendConfig.html#project_name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.labelstudio.LabelStudioBackendConfig.__init__

fiftyone.utils.labelstudio.LabelStudioBackendConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.labelstudio.LabelStudioBackendConfig._api_key

fiftyone.utils.labelstudio.LabelStudioBackendConfig.html#_api_key

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.labelstudio.LabelStudioBackendConfig.api_key

fiftyone.utils.labelstudio.LabelStudioBackendConfig.html#api_key

Attribute

Property

PUBLIC

Undocumented
fiftyone.utils.labelstudio.LabelStudioBackendConfig.api_key.setter

fiftyone.utils.labelstudio.LabelStudioBackendConfig.html#api_key.setter

Function

Method

PUBLIC

Undocumented
fiftyone.utils.labelstudio.LabelStudioBackendConfig.load_credentials

fiftyone.utils.labelstudio.LabelStudioBackendConfig.html#load_credentials

Function

Method

PUBLIC

Loads any necessary credentials from the given keyword arguments or the relevant FiftyOne config.
fiftyone.utils.labelstudio.LabelStudioBackend

fiftyone.utils.labelstudio.LabelStudioBackend.html

Class

Class

PUBLIC

Class for interacting with the Label Studio annotation backend.
fiftyone.utils.labelstudio.LabelStudioBackend.supported_media_types

fiftyone.utils.labelstudio.LabelStudioBackend.html#supported_media_types

Attribute

Property

PUBLIC

The list of media types that this backend supports.
fiftyone.utils.labelstudio.LabelStudioBackend.supported_label_types

fiftyone.utils.labelstudio.LabelStudioBackend.html#supported_label_types

Attribute

Property

PUBLIC

The list of label types supported by the backend.
fiftyone.utils.labelstudio.LabelStudioBackend.supported_scalar_types

fiftyone.utils.labelstudio.LabelStudioBackend.html#supported_scalar_types

Attribute

Property

PUBLIC

The list of scalar field types supported by the backend.
fiftyone.utils.labelstudio.LabelStudioBackend.supported_attr_types

fiftyone.utils.labelstudio.LabelStudioBackend.html#supported_attr_types

Attribute

Property

PUBLIC

The list of attribute types supported by the backend.
fiftyone.utils.labelstudio.LabelStudioBackend.supports_keyframes

fiftyone.utils.labelstudio.LabelStudioBackend.html#supports_keyframes

Attribute

Property

PUBLIC

Whether this backend supports uploading only keyframes when editing existing video track annotations.
fiftyone.utils.labelstudio.LabelStudioBackend.supports_video_sample_fields

fiftyone.utils.labelstudio.LabelStudioBackend.html#supports_video_sample_fields

Attribute

Property

PUBLIC

Whether this backend supports annotating video labels at a sample-level.
fiftyone.utils.labelstudio.LabelStudioBackend.requires_label_schema

fiftyone.utils.labelstudio.LabelStudioBackend.html#requires_label_schema

Attribute

Property

PUBLIC

Whether this backend requires a pre-defined label schema for its annotation runs.
fiftyone.utils.labelstudio.LabelStudioBackend._connect_to_api

fiftyone.utils.labelstudio.LabelStudioBackend.html#_connect_to_api

Function

Method

PRIVATE

Returns a new API instance connected to the annotation backend.
fiftyone.utils.labelstudio.LabelStudioBackend.upload_annotations

fiftyone.utils.labelstudio.LabelStudioBackend.html#upload_annotations

Function

Method

PUBLIC

Uploads the samples and relevant existing labels from the label schema to the annotation backend.
fiftyone.utils.labelstudio.LabelStudioBackend.download_annotations

fiftyone.utils.labelstudio.LabelStudioBackend.html#download_annotations

Function

Method

PUBLIC

Downloads the annotations from the annotation backend for the given results.
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html

Class

Class

PUBLIC

A class to upload tasks and predictions to and fetch annotations from Label Studio.
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.__init__

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.url

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#url

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI._api_key

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#_api_key

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.backend

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#backend

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI._min_server_version

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#_min_server_version

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI._setup

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#_setup

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI._client

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#_client

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI._verify_server_version

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#_verify_server_version

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI._init_project

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#_init_project

Function

Method

PRIVATE

Creates a new project on Label Studio.
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI._prepare_tasks

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#_prepare_tasks

Function

Method

PRIVATE

Prepares Label Studio tasks for the given data.
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI._upload_tasks

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#_upload_tasks

Function

Method

PRIVATE

Uploads files to Label Studio and registers them as tasks.
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI._get_matched_labeled_tasks

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#_get_matched_labeled_tasks

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI._import_annotations

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#_import_annotations

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI._export_to_label_studio

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#_export_to_label_studio

Function

Method

PRIVATE

Undocumented
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.upload_samples

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#upload_samples

Function

Method

PUBLIC

Uploads the given samples to Label Studio according to the given backend's annotation and server configuration.
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.download_annotations

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#download_annotations

Function

Method

PUBLIC

Downloads the annotations from the Label Studio server for the given results instance and parses them into the appropriate FiftyOne types.
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.upload_predictions

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#upload_predictions

Function

Method

PUBLIC

Uploads the given predictions to an existing Label Studio project.
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.delete_tasks

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#delete_tasks

Function

Method

PUBLIC

Deletes the given tasks from Label Studio.
fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.delete_project

fiftyone.utils.labelstudio.LabelStudioAnnotationAPI.html#delete_project

Function

Method

PUBLIC

Deletes the project from Label Studio.
fiftyone.utils.labelstudio.LabelStudioAnnotationResults

fiftyone.utils.labelstudio.LabelStudioAnnotationResults.html

Class

Class

PUBLIC

Class that stores all relevant information needed to monitor the progress of an annotation run sent to Label Studio and download the results.
fiftyone.utils.labelstudio.LabelStudioAnnotationResults.__init__

fiftyone.utils.labelstudio.LabelStudioAnnotationResults.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.labelstudio.LabelStudioAnnotationResults.project_id

fiftyone.utils.labelstudio.LabelStudioAnnotationResults.html#project_id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.labelstudio.LabelStudioAnnotationResults.uploaded_tasks

fiftyone.utils.labelstudio.LabelStudioAnnotationResults.html#uploaded_tasks

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.labelstudio.LabelStudioAnnotationResults.launch_editor

fiftyone.utils.labelstudio.LabelStudioAnnotationResults.html#launch_editor

Function

Method

PUBLIC

Open a Label Studio tab in browser.
fiftyone.utils.labelstudio.LabelStudioAnnotationResults.cleanup

fiftyone.utils.labelstudio.LabelStudioAnnotationResults.html#cleanup

Function

Method

PUBLIC

Deletes all information for this run from the annotation backend.
fiftyone.utils.labelstudio.LabelStudioAnnotationResults._from_dict

fiftyone.utils.labelstudio.LabelStudioAnnotationResults.html#_from_dict

Function

Class Method

PRIVATE

Builds an AnnotationResults from a JSON dict representation of it.
fiftyone.utils.labelstudio.generate_labeling_config

fiftyone.utils.labelstudio.html#generate_labeling_config

Function

Function

PUBLIC

Generates a labeling config for a Label Studio project.
fiftyone.utils.labelstudio._result_type

fiftyone.utils.labelstudio.html#_result_type

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio.import_label_studio_annotation

fiftyone.utils.labelstudio.html#import_label_studio_annotation

Function

Function

PUBLIC

Imports an annotation from Label Studio.
fiftyone.utils.labelstudio._update_dict

fiftyone.utils.labelstudio.html#_update_dict

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio.export_label_to_label_studio

fiftyone.utils.labelstudio.html#export_label_to_label_studio

Function

Function

PUBLIC

Exports a label to the Label Studio format.
fiftyone.utils.labelstudio._generate_prediction_id

fiftyone.utils.labelstudio.html#_generate_prediction_id

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._to_classification

fiftyone.utils.labelstudio.html#_to_classification

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._to_detection

fiftyone.utils.labelstudio.html#_to_detection

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._to_instance

fiftyone.utils.labelstudio.html#_to_instance

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._to_polyline

fiftyone.utils.labelstudio.html#_to_polyline

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._to_keypoint

fiftyone.utils.labelstudio.html#_to_keypoint

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._to_segmentation

fiftyone.utils.labelstudio.html#_to_segmentation

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._to_regression

fiftyone.utils.labelstudio.html#_to_regression

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._from_choices

fiftyone.utils.labelstudio.html#_from_choices

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._from_rectanglelabels

fiftyone.utils.labelstudio.html#_from_rectanglelabels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._from_polygonlabels

fiftyone.utils.labelstudio.html#_from_polygonlabels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._from_keypointlabels

fiftyone.utils.labelstudio.html#_from_keypointlabels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._from_brushlabels

fiftyone.utils.labelstudio.html#_from_brushlabels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._from_number

fiftyone.utils.labelstudio.html#_from_number

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._check_type

fiftyone.utils.labelstudio.html#_check_type

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._ls_tags_from_type

fiftyone.utils.labelstudio.html#_ls_tags_from_type

Function

Function

PRIVATE

Maps fiftyone types to Label Studio tags.
fiftyone.utils.labelstudio._label_class_from_tag

fiftyone.utils.labelstudio.html#_label_class_from_tag

Function

Function

PRIVATE

Maps Label Studio parent tag to FiftyOne Label type.
fiftyone.utils.labelstudio._tag_from_label

fiftyone.utils.labelstudio.html#_tag_from_label

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._normalize_values

fiftyone.utils.labelstudio.html#_normalize_values

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._denormalize_values

fiftyone.utils.labelstudio.html#_denormalize_values

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._get_label_ids

fiftyone.utils.labelstudio.html#_get_label_ids

Function

Function

PRIVATE

Undocumented
fiftyone.utils.labelstudio._LABEL_TYPES

fiftyone.utils.labelstudio.html#_LABEL_TYPES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.labelstudio._LABEL_TO_TYPE

fiftyone.utils.labelstudio.html#_LABEL_TO_TYPE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.lfw.logger

fiftyone.utils.lfw.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.lfw.download_lfw_dataset

fiftyone.utils.lfw.html#download_lfw_dataset

Function

Function

PUBLIC

Downloads and extracts the Labeled Faces in the Wild dataset.
fiftyone.utils.lfw._VIDEOS_DOWNLOAD_LINK

fiftyone.utils.lfw.html#_VIDEOS_DOWNLOAD_LINK

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.lfw._TEST_DOWNLOAD_LINK

fiftyone.utils.lfw.html#_TEST_DOWNLOAD_LINK

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.lfw._TRAIN_DOWNLOAD_LINK

fiftyone.utils.lfw.html#_TRAIN_DOWNLOAD_LINK

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.lfw._download_videos

fiftyone.utils.lfw.html#_download_videos

Function

Function

PRIVATE

Undocumented
fiftyone.utils.lfw._download_splits

fiftyone.utils.lfw.html#_download_splits

Function

Function

PRIVATE

Undocumented
fiftyone.utils.lfw._load_split_info

fiftyone.utils.lfw.html#_load_split_info

Function

Function

PRIVATE

Undocumented
fiftyone.utils.open_clip.open_clip

fiftyone.utils.open_clip.html#open_clip

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.open_clip.logger

fiftyone.utils.open_clip.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.open_clip.TorchOpenClipModelConfig

fiftyone.utils.open_clip.TorchOpenClipModelConfig.html

Class

Class

PUBLIC

Configuration for running a TorchOpenClipModel.
fiftyone.utils.open_clip.TorchOpenClipModelConfig.clip_model

fiftyone.utils.open_clip.TorchOpenClipModelConfig.html#clip_model

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.open_clip.TorchOpenClipModelConfig.pretrained

fiftyone.utils.open_clip.TorchOpenClipModelConfig.html#pretrained

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.open_clip.TorchOpenClipModelConfig.__init__

fiftyone.utils.open_clip.TorchOpenClipModelConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.open_clip.TorchOpenClipModelConfig.text_prompt

fiftyone.utils.open_clip.TorchOpenClipModelConfig.html#text_prompt

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.open_clip.TorchOpenClipModel

fiftyone.utils.open_clip.TorchOpenClipModel.html

Class

Class

PUBLIC

Torch implementation of CLIP from https://github.com/mlfoundations/open_clip.
fiftyone.utils.open_clip.TorchOpenClipModel.__init__

fiftyone.utils.open_clip.TorchOpenClipModel.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.open_clip.TorchOpenClipModel._text_features

fiftyone.utils.open_clip.TorchOpenClipModel.html#_text_features

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.open_clip.TorchOpenClipModel.preprocess

fiftyone.utils.open_clip.TorchOpenClipModel.html#preprocess

Attribute

Instance Variable

PUBLIC

Whether to apply preprocessing transforms for inference, if any.
fiftyone.utils.open_clip.TorchOpenClipModel.can_embed_prompts

fiftyone.utils.open_clip.TorchOpenClipModel.html#can_embed_prompts

Attribute

Property

PUBLIC

Whether this instance can generate prompt embeddings.
fiftyone.utils.open_clip.TorchOpenClipModel.embed_prompt

fiftyone.utils.open_clip.TorchOpenClipModel.html#embed_prompt

Function

Method

PUBLIC

Generates an embedding for the given text prompt.
fiftyone.utils.open_clip.TorchOpenClipModel.embed_prompts

fiftyone.utils.open_clip.TorchOpenClipModel.html#embed_prompts

Function

Method

PUBLIC

Generates an embedding for the given text prompts.
fiftyone.utils.open_clip.TorchOpenClipModel._load_model

fiftyone.utils.open_clip.TorchOpenClipModel.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.open_clip.TorchOpenClipModel._model

fiftyone.utils.open_clip.TorchOpenClipModel.html#_model

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.open_clip.TorchOpenClipModel._preprocess_aux

fiftyone.utils.open_clip.TorchOpenClipModel.html#_preprocess_aux

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.open_clip.TorchOpenClipModel._tokenizer

fiftyone.utils.open_clip.TorchOpenClipModel.html#_tokenizer

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.open_clip.TorchOpenClipModel._get_text_features

fiftyone.utils.open_clip.TorchOpenClipModel.html#_get_text_features

Function

Method

PRIVATE

Undocumented
fiftyone.utils.open_clip.TorchOpenClipModel._embed_prompts

fiftyone.utils.open_clip.TorchOpenClipModel.html#_embed_prompts

Function

Method

PRIVATE

Undocumented
fiftyone.utils.open_clip.TorchOpenClipModel._get_class_logits

fiftyone.utils.open_clip.TorchOpenClipModel.html#_get_class_logits

Function

Method

PRIVATE

Undocumented
fiftyone.utils.open_clip.TorchOpenClipModel._predict_all

fiftyone.utils.open_clip.TorchOpenClipModel.html#_predict_all

Function

Method

PRIVATE

Applies a forward pass to the given iterable of data and returns the raw model output with no processing applied.
fiftyone.utils.openimages.logger

fiftyone.utils.openimages.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter

fiftyone.utils.openimages.OpenImagesDatasetImporter.html

Class

Class

PUBLIC

Base class for importing datasets in Open Images format.
fiftyone.utils.openimages.OpenImagesDatasetImporter.label_types

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#label_types

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter.classes

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter.attrs

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#attrs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter.image_ids

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#image_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter.only_matching

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#only_matching

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter.load_hierarchy

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#load_hierarchy

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter.__init__

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter._images_map

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#_images_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter._info

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter._classes_map

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#_classes_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter._attrs_map

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#_attrs_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter._cls_data

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#_cls_data

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter._det_data

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#_det_data

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter._pnt_data

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#_pnt_data

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter._rel_data

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#_rel_data

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter._seg_data

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#_seg_data

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter._uuids

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter._iter_uuids

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#_iter_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter.__iter__

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter.__len__

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.openimages.OpenImagesDatasetImporter.__next__

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.openimages.OpenImagesDatasetImporter.has_dataset_info

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.openimages.OpenImagesDatasetImporter.has_image_metadata

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.openimages.OpenImagesDatasetImporter._has_scalar_labels

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#_has_scalar_labels

Attribute

Property

PRIVATE

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter.label_cls

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.openimages.OpenImagesDatasetImporter.setup

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.openimages.OpenImagesDatasetImporter._point_classes_map

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#_point_classes_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openimages.OpenImagesDatasetImporter.get_dataset_info

fiftyone.utils.openimages.OpenImagesDatasetImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.openimages.OpenImagesV6DatasetImporter

fiftyone.utils.openimages.OpenImagesV6DatasetImporter.html

Class

Class

PUBLIC

Base class for importing datasets in Open Images V6 format.
fiftyone.utils.openimages.OpenImagesV6DatasetImporter.__init__

fiftyone.utils.openimages.OpenImagesV6DatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openimages.OpenImagesV6DatasetImporter.version

fiftyone.utils.openimages.OpenImagesV6DatasetImporter.html#version

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openimages.OpenImagesV7DatasetImporter

fiftyone.utils.openimages.OpenImagesV7DatasetImporter.html

Class

Class

PUBLIC

Base class for importing datasets in Open Images V7 format.
fiftyone.utils.openimages.OpenImagesV7DatasetImporter.__init__

fiftyone.utils.openimages.OpenImagesV7DatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openimages.OpenImagesV7DatasetImporter.version

fiftyone.utils.openimages.OpenImagesV7DatasetImporter.html#version

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openimages.get_attributes

fiftyone.utils.openimages.html#get_attributes

Function

Function

PUBLIC

Gets the list of relationship attributes in the Open Images dataset.
fiftyone.utils.openimages.get_classes

fiftyone.utils.openimages.html#get_classes

Function

Function

PUBLIC

Gets the boxable classes that exist in classifications, detections, points, and relationships in the Open Images dataset.
fiftyone.utils.openimages.get_segmentation_classes

fiftyone.utils.openimages.html#get_segmentation_classes

Function

Function

PUBLIC

Gets the list of classes (350) that are labeled with segmentations in the Open Images V6/V7 dataset.
fiftyone.utils.openimages.get_point_classes

fiftyone.utils.openimages.html#get_point_classes

Function

Function

PUBLIC

Gets the list of classes that are labeled with points in the Open Images V7 dataset.
fiftyone.utils.openimages.download_open_images_split

fiftyone.utils.openimages.html#download_open_images_split

Function

Function

PUBLIC

Utility that downloads full or partial splits of the Open Images dataset.
fiftyone.utils.openimages._setup

fiftyone.utils.openimages.html#_setup

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._get_general_metadata_file

fiftyone.utils.openimages.html#_get_general_metadata_file

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._get_attrs_map

fiftyone.utils.openimages.html#_get_attrs_map

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._get_classes_map

fiftyone.utils.openimages.html#_get_classes_map

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._get_pnt_classes_map

fiftyone.utils.openimages.html#_get_pnt_classes_map

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._get_seg_classes

fiftyone.utils.openimages.html#_get_seg_classes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._get_hierarchy

fiftyone.utils.openimages.html#_get_hierarchy

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._rename_subcategories

fiftyone.utils.openimages.html#_rename_subcategories

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._parse_csv

fiftyone.utils.openimages.html#_parse_csv

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._parse_image_ids

fiftyone.utils.openimages.html#_parse_image_ids

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._parse_and_verify_image_ids

fiftyone.utils.openimages.html#_parse_and_verify_image_ids

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._parse_label_types

fiftyone.utils.openimages.html#_parse_label_types

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._verify_image_ids

fiftyone.utils.openimages.html#_verify_image_ids

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._get_downloaded_image_ids

fiftyone.utils.openimages.html#_get_downloaded_image_ids

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._get_all_label_data

fiftyone.utils.openimages.html#_get_all_label_data

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._get_label_data

fiftyone.utils.openimages.html#_get_label_data

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._download

fiftyone.utils.openimages.html#_download

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._get_dataframe_rows

fiftyone.utils.openimages.html#_get_dataframe_rows

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._create_classifications

fiftyone.utils.openimages.html#_create_classifications

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._create_detections

fiftyone.utils.openimages.html#_create_detections

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._create_relationships

fiftyone.utils.openimages.html#_create_relationships

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._create_points

fiftyone.utils.openimages.html#_create_points

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._create_segmentations

fiftyone.utils.openimages.html#_create_segmentations

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._load_all_image_ids

fiftyone.utils.openimages.html#_load_all_image_ids

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._download_file_if_necessary

fiftyone.utils.openimages.html#_download_file_if_necessary

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._download_masks_if_necessary

fiftyone.utils.openimages.html#_download_masks_if_necessary

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._download_images_if_necessary

fiftyone.utils.openimages.html#_download_images_if_necessary

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._verify_version

fiftyone.utils.openimages.html#_verify_version

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openimages._ANNOTATION_DOWNLOAD_URLS

fiftyone.utils.openimages.html#_ANNOTATION_DOWNLOAD_URLS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.openimages._BUCKET_NAME

fiftyone.utils.openimages.html#_BUCKET_NAME

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.openimages._CSV_DELIMITERS

fiftyone.utils.openimages.html#_CSV_DELIMITERS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.openimages._SUPPORTED_LABEL_TYPES_V6

fiftyone.utils.openimages.html#_SUPPORTED_LABEL_TYPES_V6

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.openimages._SUPPORTED_LABEL_TYPES_V7

fiftyone.utils.openimages.html#_SUPPORTED_LABEL_TYPES_V7

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.openimages._SUPPORTED_LABEL_TYPES

fiftyone.utils.openimages.html#_SUPPORTED_LABEL_TYPES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.openimages._SUPPORTED_SPLITS

fiftyone.utils.openimages.html#_SUPPORTED_SPLITS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.openimages._SUPPORTED_VERSIONS

fiftyone.utils.openimages.html#_SUPPORTED_VERSIONS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.openlabel.logger

fiftyone.utils.openlabel.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.SegmentationType

fiftyone.utils.openlabel.SegmentationType.html

Class

Class

PUBLIC

The FiftyOne label type used to store segmentations
fiftyone.utils.openlabel.SegmentationType.INSTANCE

fiftyone.utils.openlabel.SegmentationType.html#INSTANCE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.openlabel.SegmentationType.POLYLINE

fiftyone.utils.openlabel.SegmentationType.html#POLYLINE

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.openlabel.SegmentationType.SEMANTIC

fiftyone.utils.openlabel.SegmentationType.html#SEMANTIC

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html

Class

Class

PUBLIC

Importer for OpenLABEL image datasets stored on disk.
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.data_path

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.labels_path

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.use_polylines

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#use_polylines

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.skeleton

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#skeleton

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.skeleton_key

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#skeleton_key

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.__init__

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter._label_types

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#_label_types

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter._info

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter._image_paths_map

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#_image_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter._annotations

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#_annotations

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter._file_ids

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#_file_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter._iter_file_ids

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#_iter_file_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.__iter__

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.__len__

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.__next__

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.has_dataset_info

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.has_image_metadata

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter._has_scalar_labels

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#_has_scalar_labels

Attribute

Property

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.label_cls

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.setup

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.get_dataset_info

fiftyone.utils.openlabel.OpenLABELImageDatasetImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html

Class

Class

PUBLIC

Importer for OpenLABEL video datasets stored on disk.
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.data_path

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.labels_path

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.use_polylines

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#use_polylines

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.skeleton

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#skeleton

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.skeleton_key

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#skeleton_key

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.__init__

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter._label_types

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#_label_types

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter._info

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter._video_paths_map

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#_video_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter._annotations

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#_annotations

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter._file_ids

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#_file_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter._iter_file_ids

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#_iter_file_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.__iter__

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.__len__

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.__next__

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.has_dataset_info

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.has_video_metadata

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#has_video_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.VideoMetadata instances for each video.
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.label_cls

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer within the sample-level labels that it produces.
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.setup

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.get_dataset_info

fiftyone.utils.openlabel.OpenLABELVideoDatasetImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.openlabel.OpenLABELAnnotations

fiftyone.utils.openlabel.OpenLABELAnnotations.html

Class

Class

PUBLIC

Annotations parsed from OpenLABEL format able to be converted to FiftyOne labels.
fiftyone.utils.openlabel.OpenLABELAnnotations.__init__

fiftyone.utils.openlabel.OpenLABELAnnotations.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELAnnotations.objects

fiftyone.utils.openlabel.OpenLABELAnnotations.html#objects

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELAnnotations.streams

fiftyone.utils.openlabel.OpenLABELAnnotations.html#streams

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELAnnotations.metadata

fiftyone.utils.openlabel.OpenLABELAnnotations.html#metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELAnnotations.parse_labels

fiftyone.utils.openlabel.OpenLABELAnnotations.html#parse_labels

Function

Method

PUBLIC

Parses a single OpenLABEL labels file.
fiftyone.utils.openlabel.OpenLABELAnnotations._parse_frames

fiftyone.utils.openlabel.OpenLABELAnnotations.html#_parse_frames

Function

Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELAnnotations.get_dimensions

fiftyone.utils.openlabel.OpenLABELAnnotations.html#get_dimensions

Function

Method

PUBLIC

Get the width and height of a given URI or file id
fiftyone.utils.openlabel.OpenLABELAnnotations.get_labels

fiftyone.utils.openlabel.OpenLABELAnnotations.html#get_labels

Function

Method

PUBLIC

Get the FiftyOne labels corresponding to the annotations of a given URI. The results are two dictionaries, sample- and frame-level, mapping field names to values and label objects.
fiftyone.utils.openlabel.OpenLABELStreamInfos

fiftyone.utils.openlabel.OpenLABELStreamInfos.html

Class

Class

PUBLIC

A collection of multiple OpenLABELStreamInfo objects.
fiftyone.utils.openlabel.OpenLABELStreamInfos.__init__

fiftyone.utils.openlabel.OpenLABELStreamInfos.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELStreamInfos.infos

fiftyone.utils.openlabel.OpenLABELStreamInfos.html#infos

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELStreamInfos.get_stream_attributes

fiftyone.utils.openlabel.OpenLABELStreamInfos.html#get_stream_attributes

Function

Method

PUBLIC

Aggregates attributes from all streams in this collection.
fiftyone.utils.openlabel.OpenLABELStreamInfos.frame_numbers

fiftyone.utils.openlabel.OpenLABELStreamInfos.html#frame_numbers

Attribute

Property

PUBLIC

All frame numbers existing in the OpenLABELStreamInfo objects in this collection.
fiftyone.utils.openlabel.OpenLABELStreamInfo

fiftyone.utils.openlabel.OpenLABELStreamInfo.html

Class

Class

PUBLIC

Information about a stream used to gather specific objects for a media file.
fiftyone.utils.openlabel.OpenLABELStreamInfo.frame_numbers

fiftyone.utils.openlabel.OpenLABELStreamInfo.html#frame_numbers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELStreamInfo.stream

fiftyone.utils.openlabel.OpenLABELStreamInfo.html#stream

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELStreamInfo.label_file_id

fiftyone.utils.openlabel.OpenLABELStreamInfo.html#label_file_id

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELStreamInfo.is_sample_level

fiftyone.utils.openlabel.OpenLABELStreamInfo.html#is_sample_level

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELStreamInfo.__init__

fiftyone.utils.openlabel.OpenLABELStreamInfo.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELStreamInfo.is_streamless

fiftyone.utils.openlabel.OpenLABELStreamInfo.html#is_streamless

Attribute

Property

PUBLIC

Whether there exists a stream corresponding to this info.
fiftyone.utils.openlabel.OpenLABELStreamInfo.get_stream_attributes

fiftyone.utils.openlabel.OpenLABELStreamInfo.html#get_stream_attributes

Function

Method

PUBLIC

Get a dictionary of attributes for the stream in this object.
fiftyone.utils.openlabel.OpenLABELGroup

fiftyone.utils.openlabel.OpenLABELGroup.html

Class

Class

PUBLIC

A utility for parsing groups of OpenLABEL elements
fiftyone.utils.openlabel.OpenLABELGroup.__init__

fiftyone.utils.openlabel.OpenLABELGroup.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELGroup._element_id_to_element

fiftyone.utils.openlabel.OpenLABELGroup.html#_element_id_to_element

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELGroup._keys_by_label_file_id

fiftyone.utils.openlabel.OpenLABELGroup.html#_keys_by_label_file_id

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELGroup._parse_group_dict

fiftyone.utils.openlabel.OpenLABELGroup.html#_parse_group_dict

Function

Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELGroup._element_type

fiftyone.utils.openlabel.OpenLABELGroup.html#_element_type

Attribute

Property

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELGroup._get_element_id

fiftyone.utils.openlabel.OpenLABELGroup.html#_get_element_id

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELGroup._get_label_file_id

fiftyone.utils.openlabel.OpenLABELGroup.html#_get_label_file_id

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELGroup._add_element_dict

fiftyone.utils.openlabel.OpenLABELGroup.html#_add_element_dict

Function

Method

PRIVATE

Parses the given raw stream dictionary.
fiftyone.utils.openlabel.OpenLABELObjects

fiftyone.utils.openlabel.OpenLABELObjects.html

Class

Class

PUBLIC

A collection of OpenLABELObject and corresponding utility methods.
fiftyone.utils.openlabel.OpenLABELObjects.streams

fiftyone.utils.openlabel.OpenLABELObjects.html#streams

Attribute

Property

PUBLIC

Get streams corresponding to any object in this collection.
fiftyone.utils.openlabel.OpenLABELObjects.all_objects

fiftyone.utils.openlabel.OpenLABELObjects.html#all_objects

Attribute

Property

PUBLIC

A list of OpenLABELObject instances in this collection.
fiftyone.utils.openlabel.OpenLABELObjects.parse_objects_dict

fiftyone.utils.openlabel.OpenLABELObjects.html#parse_objects_dict

Function

Method

PUBLIC

Parses the OpenLABEL annotations corresponding to a specific dictionary of objects.
fiftyone.utils.openlabel.OpenLABELObjects._element_type

fiftyone.utils.openlabel.OpenLABELObjects.html#_element_type

Attribute

Property

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELObjects.add_object

fiftyone.utils.openlabel.OpenLABELObjects.html#add_object

Function

Method

PUBLIC

Adds an OpenLABELObject to this collection.
fiftyone.utils.openlabel.OpenLABELObjects._get_filtered_object

fiftyone.utils.openlabel.OpenLABELObjects.html#_get_filtered_object

Function

Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELObjects.get_objects

fiftyone.utils.openlabel.OpenLABELObjects.html#get_objects

Function

Method

PUBLIC

Gets any objects that correspond to an info in the given stream infos.
fiftyone.utils.openlabel.OpenLABELObjects.to_labels

fiftyone.utils.openlabel.OpenLABELObjects.html#to_labels

Function

Method

PUBLIC

Converts the stored OpenLABELObject to FiftyOne labels.
fiftyone.utils.openlabel.OpenLABELStreams

fiftyone.utils.openlabel.OpenLABELStreams.html

Class

Class

PUBLIC

A collection of OpenLABEL streams.
fiftyone.utils.openlabel.OpenLABELStreams.__init__

fiftyone.utils.openlabel.OpenLABELStreams.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELStreams._uri_to_stream_ids

fiftyone.utils.openlabel.OpenLABELStreams.html#_uri_to_stream_ids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELStreams.uris

fiftyone.utils.openlabel.OpenLABELStreams.html#uris

Attribute

Property

PUBLIC

All unique media file identifiers corresponding to streams in this collection.
fiftyone.utils.openlabel.OpenLABELStreams.parse_streams_dict

fiftyone.utils.openlabel.OpenLABELStreams.html#parse_streams_dict

Function

Method

PUBLIC

Parses the OpenLABEL annotations corresponding to a specific dictionary of streams.
fiftyone.utils.openlabel.OpenLABELStreams.get_dimensions

fiftyone.utils.openlabel.OpenLABELStreams.html#get_dimensions

Function

Method

PUBLIC

Get the width and height of a given URI or file id.
fiftyone.utils.openlabel.OpenLABELStreams._element_type

fiftyone.utils.openlabel.OpenLABELStreams.html#_element_type

Attribute

Property

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELStreams._add_stream_dict

fiftyone.utils.openlabel.OpenLABELStreams.html#_add_stream_dict

Function

Method

PRIVATE

Parses the given raw stream dictionary.
fiftyone.utils.openlabel.OpenLABELStreams.get_stream_info

fiftyone.utils.openlabel.OpenLABELStreams.html#get_stream_info

Function

Method

PUBLIC

Get all stream infos, including stream and relevant frame numbers, for a given media file identifier.
fiftyone.utils.openlabel.AttributeParser

fiftyone.utils.openlabel.AttributeParser.html

Class

Class

PUBLIC

Methods used to parse attributes from OpenLABEL annotations.
fiftyone.utils.openlabel.AttributeParser._STREAM_KEYS

fiftyone.utils.openlabel.AttributeParser.html#_STREAM_KEYS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.openlabel.AttributeParser._IGNORE_KEYS

fiftyone.utils.openlabel.AttributeParser.html#_IGNORE_KEYS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.openlabel.AttributeParser._parse_attributes

fiftyone.utils.openlabel.AttributeParser.html#_parse_attributes

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.AttributeParser._parse_name_val_attributes

fiftyone.utils.openlabel.AttributeParser.html#_parse_name_val_attributes

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELShape

fiftyone.utils.openlabel.OpenLABELShape.html

Class

Class

PUBLIC

A single OpenLABEL shape like a bounding box or polygon.
fiftyone.utils.openlabel.OpenLABELShape.__init__

fiftyone.utils.openlabel.OpenLABELShape.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELShape.coords

fiftyone.utils.openlabel.OpenLABELShape.html#coords

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELShape.attributes

fiftyone.utils.openlabel.OpenLABELShape.html#attributes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELShape.stream

fiftyone.utils.openlabel.OpenLABELShape.html#stream

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELShape.from_shape_dict

fiftyone.utils.openlabel.OpenLABELShape.html#from_shape_dict

Function

Class Method

PUBLIC

Constructs a shape from a dictionary of information.
fiftyone.utils.openlabel.OpenLABELBBox

fiftyone.utils.openlabel.OpenLABELBBox.html

Class

Class

PUBLIC

An OpenLABEL bounding box.
fiftyone.utils.openlabel.OpenLABELBBox.to_label

fiftyone.utils.openlabel.OpenLABELBBox.html#to_label

Function

Method

PUBLIC

Convert this shape to a FiftyOne label.
fiftyone.utils.openlabel.OpenLABELPoly2D

fiftyone.utils.openlabel.OpenLABELPoly2D.html

Class

Class

PUBLIC

An OpenLABEL polyline.
fiftyone.utils.openlabel.OpenLABELPoly2D.to_label

fiftyone.utils.openlabel.OpenLABELPoly2D.html#to_label

Function

Method

PUBLIC

Convert this shape to a FiftyOne label.
fiftyone.utils.openlabel.OpenLABELPoint

fiftyone.utils.openlabel.OpenLABELPoint.html

Class

Class

PUBLIC

An OpenLABEL keypoint.
fiftyone.utils.openlabel.OpenLABELPoint._get_empty_value_for_type

fiftyone.utils.openlabel.OpenLABELPoint.html#_get_empty_value_for_type

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELPoint._sort_by_skeleton

fiftyone.utils.openlabel.OpenLABELPoint.html#_sort_by_skeleton

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELPoint.to_label

fiftyone.utils.openlabel.OpenLABELPoint.html#to_label

Function

Method

PUBLIC

Convert this shape to a FiftyOne label.
fiftyone.utils.openlabel.OpenLABELShapes

fiftyone.utils.openlabel.OpenLABELShapes.html

Class

Class

PUBLIC

A collection of OpenLABEL shapes.
fiftyone.utils.openlabel.OpenLABELShapes.__init__

fiftyone.utils.openlabel.OpenLABELShapes.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELShapes.shapes

fiftyone.utils.openlabel.OpenLABELShapes.html#shapes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELShapes.attributes

fiftyone.utils.openlabel.OpenLABELShapes.html#attributes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELShapes.stream

fiftyone.utils.openlabel.OpenLABELShapes.html#stream

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELShapes.streams

fiftyone.utils.openlabel.OpenLABELShapes.html#streams

Attribute

Property

PUBLIC

A list of streams corresponding to any object in this collection.
fiftyone.utils.openlabel.OpenLABELShapes.from_object_data_list

fiftyone.utils.openlabel.OpenLABELShapes.html#from_object_data_list

Function

Class Method

PUBLIC

Construct an OpenLABELShapes from a list of shape dictionaries.
fiftyone.utils.openlabel.OpenLABELShapes.merge_shapes

fiftyone.utils.openlabel.OpenLABELShapes.html#merge_shapes

Function

Method

PUBLIC

Merges another OpenLABELShapes into this one.
fiftyone.utils.openlabel.OpenLABELShapes.to_labels

fiftyone.utils.openlabel.OpenLABELShapes.html#to_labels

Function

Method

PUBLIC

Convert this shape to a FiftyOne label.
fiftyone.utils.openlabel.OpenLABELShapes._homogenous_shape_types

fiftyone.utils.openlabel.OpenLABELShapes.html#_homogenous_shape_types

Attribute

Property

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELShapes._to_point_labels

fiftyone.utils.openlabel.OpenLABELShapes.html#_to_point_labels

Function

Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELShapes._to_individual_labels

fiftyone.utils.openlabel.OpenLABELShapes.html#_to_individual_labels

Function

Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELStream

fiftyone.utils.openlabel.OpenLABELStream.html

Class

Class

PUBLIC

An OpenLABEL stream corresponding to one uri or file_id.
fiftyone.utils.openlabel.OpenLABELStream.name

fiftyone.utils.openlabel.OpenLABELStream.html#name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELStream.type

fiftyone.utils.openlabel.OpenLABELStream.html#type

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELStream.properties

fiftyone.utils.openlabel.OpenLABELStream.html#properties

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELStream.other_attrs

fiftyone.utils.openlabel.OpenLABELStream.html#other_attrs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELStream._HEIGHT_KEYS

fiftyone.utils.openlabel.OpenLABELStream.html#_HEIGHT_KEYS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELStream._WIDTH_KEYS

fiftyone.utils.openlabel.OpenLABELStream.html#_WIDTH_KEYS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELStream._URI_KEYS

fiftyone.utils.openlabel.OpenLABELStream.html#_URI_KEYS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELStream.__init__

fiftyone.utils.openlabel.OpenLABELStream.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELStream.height

fiftyone.utils.openlabel.OpenLABELStream.html#height

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELStream.width

fiftyone.utils.openlabel.OpenLABELStream.html#width

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELStream._uris

fiftyone.utils.openlabel.OpenLABELStream.html#_uris

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELStream.frame_streams

fiftyone.utils.openlabel.OpenLABELStream.html#frame_streams

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELStream._parse_properties_dict

fiftyone.utils.openlabel.OpenLABELStream.html#_parse_properties_dict

Function

Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELStream._check_height_width

fiftyone.utils.openlabel.OpenLABELStream.html#_check_height_width

Function

Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELStream.update_dict

fiftyone.utils.openlabel.OpenLABELStream.html#update_dict

Function

Method

PUBLIC

Updates this stream with additional information.
fiftyone.utils.openlabel.OpenLABELStream.uris

fiftyone.utils.openlabel.OpenLABELStream.html#uris

Attribute

Property

PUBLIC

Get uris corresponding to any stream in this collection.
fiftyone.utils.openlabel.OpenLABELStream.get_frame_numbers

fiftyone.utils.openlabel.OpenLABELStream.html#get_frame_numbers

Function

Method

PUBLIC

Get frame numbers corresponding to the given uri.
fiftyone.utils.openlabel.OpenLABELStream.from_anno_dict

fiftyone.utils.openlabel.OpenLABELStream.html#from_anno_dict

Function

Class Method

PUBLIC

Create an OpenLABEL stream from the stream information dictionary.
fiftyone.utils.openlabel.OpenLABELStream._parse_stream_dict

fiftyone.utils.openlabel.OpenLABELStream.html#_parse_stream_dict

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELMetadata

fiftyone.utils.openlabel.OpenLABELMetadata.html

Class

Class

PUBLIC

A parser and storage for OpenLABEL metadata.
fiftyone.utils.openlabel.OpenLABELMetadata._POTENTIAL_FILENAME_KEYS

fiftyone.utils.openlabel.OpenLABELMetadata.html#_POTENTIAL_FILENAME_KEYS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELMetadata.__init__

fiftyone.utils.openlabel.OpenLABELMetadata.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELMetadata.metadata_dict

fiftyone.utils.openlabel.OpenLABELMetadata.html#metadata_dict

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELMetadata._parse_seg_type

fiftyone.utils.openlabel.OpenLABELMetadata.html#_parse_seg_type

Function

Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELMetadata.seg_type

fiftyone.utils.openlabel.OpenLABELMetadata.html#seg_type

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELMetadata.parse_potential_file_ids

fiftyone.utils.openlabel.OpenLABELMetadata.html#parse_potential_file_ids

Function

Method

PUBLIC

Parses metadata for any fields that may correspond to a label-wide media file_id.
fiftyone.utils.openlabel.OpenLABELObject

fiftyone.utils.openlabel.OpenLABELObject.html

Class

Class

PUBLIC

An object parsed from OpenLABEL labels.
fiftyone.utils.openlabel.OpenLABELObject.name

fiftyone.utils.openlabel.OpenLABELObject.html#name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELObject.type

fiftyone.utils.openlabel.OpenLABELObject.html#type

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELObject.stream

fiftyone.utils.openlabel.OpenLABELObject.html#stream

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELObject.other_attrs

fiftyone.utils.openlabel.OpenLABELObject.html#other_attrs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELObject.is_frame_level

fiftyone.utils.openlabel.OpenLABELObject.html#is_frame_level

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELObject._STREAM_KEYS

fiftyone.utils.openlabel.OpenLABELObject.html#_STREAM_KEYS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELObject.__init__

fiftyone.utils.openlabel.OpenLABELObject.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELObject.shapes

fiftyone.utils.openlabel.OpenLABELObject.html#shapes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELObject.key

fiftyone.utils.openlabel.OpenLABELObject.html#key

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELObject.frame_objects

fiftyone.utils.openlabel.OpenLABELObject.html#frame_objects

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.openlabel.OpenLABELObject._sample_level_streams

fiftyone.utils.openlabel.OpenLABELObject.html#_sample_level_streams

Attribute

Property

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELObject.streams

fiftyone.utils.openlabel.OpenLABELObject.html#streams

Attribute

Property

PUBLIC

Get streams corresponding to this object.
fiftyone.utils.openlabel.OpenLABELObject.is_streamless

fiftyone.utils.openlabel.OpenLABELObject.html#is_streamless

Attribute

Property

PUBLIC

Whether any streams are connected to this object or corresponding frame-level objects.
fiftyone.utils.openlabel.OpenLABELObject.filter_stream

fiftyone.utils.openlabel.OpenLABELObject.html#filter_stream

Function

Method

PUBLIC

Filters this object to contain only frame labels specified in the given stream info
fiftyone.utils.openlabel.OpenLABELObject._keep_frames

fiftyone.utils.openlabel.OpenLABELObject.html#_keep_frames

Function

Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELObject._to_labels

fiftyone.utils.openlabel.OpenLABELObject.html#_to_labels

Function

Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELObject.to_detections

fiftyone.utils.openlabel.OpenLABELObject.html#to_detections

Function

Method

PUBLIC

Converts the bounding boxes in this object to fiftyone.core.labels.Detection objects.
fiftyone.utils.openlabel.OpenLABELObject._get_label_attrs

fiftyone.utils.openlabel.OpenLABELObject.html#_get_label_attrs

Function

Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELObject.to_polylines

fiftyone.utils.openlabel.OpenLABELObject.html#to_polylines

Function

Method

PUBLIC

Converts the segmentations in this object to fiftyone.core.labels.Polyline objects.
fiftyone.utils.openlabel.OpenLABELObject.to_keypoints

fiftyone.utils.openlabel.OpenLABELObject.html#to_keypoints

Function

Method

PUBLIC

Converts the keypoints in this object to fiftyone.core.labels.Keypoint objects.
fiftyone.utils.openlabel.OpenLABELObject.from_anno_dict

fiftyone.utils.openlabel.OpenLABELObject.html#from_anno_dict

Function

Class Method

PUBLIC

Create an OpenLABELObject from the raw label dictionary.
fiftyone.utils.openlabel.OpenLABELObject._get_shape_list

fiftyone.utils.openlabel.OpenLABELObject.html#_get_shape_list

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELObject._parse_object_dict

fiftyone.utils.openlabel.OpenLABELObject.html#_parse_object_dict

Function

Class Method

PRIVATE

Undocumented
fiftyone.utils.openlabel.OpenLABELObject.update_dict

fiftyone.utils.openlabel.OpenLABELObject.html#update_dict

Function

Method

PUBLIC

Updates this OpenLABELObject given the raw label dictionary.
fiftyone.utils.openlabel.OpenLABELObject._get_object_attributes

fiftyone.utils.openlabel.OpenLABELObject.html#_get_object_attributes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.openlabel._validate_file_ids

fiftyone.utils.openlabel.html#_validate_file_ids

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openlabel._parse_label_types

fiftyone.utils.openlabel.html#_parse_label_types

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openlabel._SUPPORTED_LABEL_TYPES

fiftyone.utils.openlabel.html#_SUPPORTED_LABEL_TYPES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.openlabel._pairwise

fiftyone.utils.openlabel.html#_pairwise

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openlabel._remove_ext

fiftyone.utils.openlabel.html#_remove_ext

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openlabel._merge_frame_labels

fiftyone.utils.openlabel.html#_merge_frame_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openlabel._extend_labels

fiftyone.utils.openlabel.html#_extend_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openlabel._remove_empty_labels

fiftyone.utils.openlabel.html#_remove_empty_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.openlabel._remove_empty_label_type

fiftyone.utils.openlabel.html#_remove_empty_label_type

Function

Function

PRIVATE

Undocumented
fiftyone.utils.patches.ImagePatchesExtractor

fiftyone.utils.patches.ImagePatchesExtractor.html

Class

Class

PUBLIC

Class for iterating over the labeled/unlabeled image patches in a collection.
fiftyone.utils.patches.ImagePatchesExtractor.patches_field

fiftyone.utils.patches.ImagePatchesExtractor.html#patches_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.patches.ImagePatchesExtractor.include_labels

fiftyone.utils.patches.ImagePatchesExtractor.html#include_labels

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.patches.ImagePatchesExtractor.force_rgb

fiftyone.utils.patches.ImagePatchesExtractor.html#force_rgb

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.patches.ImagePatchesExtractor.force_square

fiftyone.utils.patches.ImagePatchesExtractor.html#force_square

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.patches.ImagePatchesExtractor.alpha

fiftyone.utils.patches.ImagePatchesExtractor.html#alpha

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.patches.ImagePatchesExtractor.__init__

fiftyone.utils.patches.ImagePatchesExtractor.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.patches.ImagePatchesExtractor.samples

fiftyone.utils.patches.ImagePatchesExtractor.html#samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.patches.ImagePatchesExtractor.__len__

fiftyone.utils.patches.ImagePatchesExtractor.html#__len__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.patches.ImagePatchesExtractor.__iter__

fiftyone.utils.patches.ImagePatchesExtractor.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.patches.parse_patches

fiftyone.utils.patches.html#parse_patches

Function

Function

PUBLIC

Parses the patches from the given document.
fiftyone.utils.patches.extract_patch

fiftyone.utils.patches.html#extract_patch

Function

Function

PUBLIC

Extracts the patch from the image.
fiftyone.utils.patches._load_image

fiftyone.utils.patches.html#_load_image

Function

Function

PRIVATE

Undocumented
fiftyone.utils.patches._to_classification

fiftyone.utils.patches.html#_to_classification

Function

Function

PRIVATE

Undocumented
fiftyone.utils.places.logger

fiftyone.utils.places.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.places.download_places_dataset_split

fiftyone.utils.places.html#download_places_dataset_split

Function

Function

PUBLIC

Utility that downloads splits of the Places dataset.
fiftyone.utils.places.PlacesDatasetImporter

fiftyone.utils.places.PlacesDatasetImporter.html

Class

Class

PUBLIC

Class for importing datasets written by download_places_dataset_split`.
fiftyone.utils.places.PlacesDatasetImporter.__init__

fiftyone.utils.places.PlacesDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.places.PlacesDatasetImporter._images_map

fiftyone.utils.places.PlacesDatasetImporter.html#_images_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.places.PlacesDatasetImporter._labels_map

fiftyone.utils.places.PlacesDatasetImporter.html#_labels_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.places.PlacesDatasetImporter._uuids

fiftyone.utils.places.PlacesDatasetImporter.html#_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.places.PlacesDatasetImporter._iter_uuids

fiftyone.utils.places.PlacesDatasetImporter.html#_iter_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.places.PlacesDatasetImporter.has_image_metadata

fiftyone.utils.places.PlacesDatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.places.PlacesDatasetImporter.has_dataset_info

fiftyone.utils.places.PlacesDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.places.PlacesDatasetImporter.label_cls

fiftyone.utils.places.PlacesDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.places.PlacesDatasetImporter.__iter__

fiftyone.utils.places.PlacesDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.places.PlacesDatasetImporter.__len__

fiftyone.utils.places.PlacesDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.places.PlacesDatasetImporter.__next__

fiftyone.utils.places.PlacesDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.places.PlacesDatasetImporter.setup

fiftyone.utils.places.PlacesDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.places.PlacesDatasetImporter._get_num_samples

fiftyone.utils.places.PlacesDatasetImporter.html#_get_num_samples

Function

Static Method

PRIVATE

Undocumented
fiftyone.utils.places._IMAGE_DOWNLOAD_LINKS

fiftyone.utils.places.html#_IMAGE_DOWNLOAD_LINKS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.places._TAR_NAMES

fiftyone.utils.places.html#_TAR_NAMES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.places._ANNOTATION_DOWNLOAD_LINK

fiftyone.utils.places.html#_ANNOTATION_DOWNLOAD_LINK

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.places._ANNOTATION_FILE

fiftyone.utils.places.html#_ANNOTATION_FILE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.places._SPLIT_SIZES

fiftyone.utils.places.html#_SPLIT_SIZES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.places._SUPPORTED_SPLITS

fiftyone.utils.places.html#_SUPPORTED_SPLITS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.random.random_split

fiftyone.utils.random.html#random_split

Function

Function

PUBLIC

Generates a random partition of the samples in the collection according to the specified split fractions.
fiftyone.utils.random.weighted_sample

fiftyone.utils.random.html#weighted_sample

Function

Function

PUBLIC

Generates a random sample of size k from the given collection such that the probability of selecting each sample is proportional to the given per-sample weights.
fiftyone.utils.random.balanced_sample

fiftyone.utils.random.html#balanced_sample

Function

Function

PUBLIC

Generates a random sample of size k from the given collection such that the expected histogram of path values in the sample is uniform.
fiftyone.utils.sam.sam

fiftyone.utils.sam.html#sam

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.sam.SegmentAnythingModelConfig

fiftyone.utils.sam.SegmentAnythingModelConfig.html

Class

Class

PUBLIC

Configuration for running a SegmentAnythingModel.
fiftyone.utils.sam.SegmentAnythingModelConfig.auto_kwargs

fiftyone.utils.sam.SegmentAnythingModelConfig.html#auto_kwargs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.sam.SegmentAnythingModelConfig.points_mask_index

fiftyone.utils.sam.SegmentAnythingModelConfig.html#points_mask_index

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.sam.SegmentAnythingModelConfig.__init__

fiftyone.utils.sam.SegmentAnythingModelConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.sam.SegmentAnythingModel

fiftyone.utils.sam.SegmentAnythingModel.html

Class

Class

PUBLIC

Wrapper for running Segment Anything inference.
fiftyone.utils.sam.SegmentAnythingModel.__init__

fiftyone.utils.sam.SegmentAnythingModel.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.sam.SegmentAnythingModel._curr_prompt_type

fiftyone.utils.sam.SegmentAnythingModel.html#_curr_prompt_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.sam.SegmentAnythingModel._curr_prompts

fiftyone.utils.sam.SegmentAnythingModel.html#_curr_prompts

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.sam.SegmentAnythingModel._curr_classes

fiftyone.utils.sam.SegmentAnythingModel.html#_curr_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.sam.SegmentAnythingModel._download_model

fiftyone.utils.sam.SegmentAnythingModel.html#_download_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam.SegmentAnythingModel._load_model

fiftyone.utils.sam.SegmentAnythingModel.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam.SegmentAnythingModel.predict_all

fiftyone.utils.sam.SegmentAnythingModel.html#predict_all

Function

Method

PUBLIC

Performs prediction on the given iterable of data.
fiftyone.utils.sam.SegmentAnythingModel._get_field

fiftyone.utils.sam.SegmentAnythingModel.html#_get_field

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam.SegmentAnythingModel._parse_samples

fiftyone.utils.sam.SegmentAnythingModel.html#_parse_samples

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam.SegmentAnythingModel._get_prompt_type

fiftyone.utils.sam.SegmentAnythingModel.html#_get_prompt_type

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam.SegmentAnythingModel._get_prompts

fiftyone.utils.sam.SegmentAnythingModel.html#_get_prompts

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam.SegmentAnythingModel._get_classes

fiftyone.utils.sam.SegmentAnythingModel.html#_get_classes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam.SegmentAnythingModel._forward_pass

fiftyone.utils.sam.SegmentAnythingModel.html#_forward_pass

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam.SegmentAnythingModel._load_predictor

fiftyone.utils.sam.SegmentAnythingModel.html#_load_predictor

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam.SegmentAnythingModel._forward_pass_boxes

fiftyone.utils.sam.SegmentAnythingModel.html#_forward_pass_boxes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam.SegmentAnythingModel._output_processor

fiftyone.utils.sam.SegmentAnythingModel.html#_output_processor

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.sam.SegmentAnythingModel._forward_pass_points

fiftyone.utils.sam.SegmentAnythingModel.html#_forward_pass_points

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam.SegmentAnythingModel._load_auto_generator

fiftyone.utils.sam.SegmentAnythingModel.html#_load_auto_generator

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam.SegmentAnythingModel._forward_pass_auto

fiftyone.utils.sam.SegmentAnythingModel.html#_forward_pass_auto

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam._to_sam_input

fiftyone.utils.sam.html#_to_sam_input

Function

Function

PRIVATE

Undocumented
fiftyone.utils.sam._to_sam_points

fiftyone.utils.sam.html#_to_sam_points

Function

Function

PRIVATE

Undocumented
fiftyone.utils.sam._to_sam_box

fiftyone.utils.sam.html#_to_sam_box

Function

Function

PRIVATE

Undocumented
fiftyone.utils.sam._mask_to_box

fiftyone.utils.sam.html#_mask_to_box

Function

Function

PRIVATE

Undocumented
fiftyone.utils.sam2.sam2

fiftyone.utils.sam2.html#sam2

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.sam2.samg

fiftyone.utils.sam2.html#samg

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.sam2.smip

fiftyone.utils.sam2.html#smip

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.sam2.smutil

fiftyone.utils.sam2.html#smutil

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.sam2.logger

fiftyone.utils.sam2.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.sam2.SegmentAnything2ImageModelConfig

fiftyone.utils.sam2.SegmentAnything2ImageModelConfig.html

Class

Class

PUBLIC

Configuration for running a SegmentAnything2ImageModel.
fiftyone.utils.sam2.SegmentAnything2ImageModelConfig.auto_kwargs

fiftyone.utils.sam2.SegmentAnything2ImageModelConfig.html#auto_kwargs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.sam2.SegmentAnything2ImageModelConfig.points_mask_index

fiftyone.utils.sam2.SegmentAnything2ImageModelConfig.html#points_mask_index

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.sam2.SegmentAnything2ImageModelConfig.__init__

fiftyone.utils.sam2.SegmentAnything2ImageModelConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModelConfig

fiftyone.utils.sam2.SegmentAnything2VideoModelConfig.html

Class

Class

PUBLIC

Configuration for running a SegmentAnything2VideoModel.
fiftyone.utils.sam2.SegmentAnything2VideoModelConfig.__init__

fiftyone.utils.sam2.SegmentAnything2VideoModelConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.sam2.SegmentAnything2ImageModel

fiftyone.utils.sam2.SegmentAnything2ImageModel.html

Class

Class

PUBLIC

Wrapper for running Segment Anything 2 inference on images.
fiftyone.utils.sam2.SegmentAnything2ImageModel.__init__

fiftyone.utils.sam2.SegmentAnything2ImageModel.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.sam2.SegmentAnything2ImageModel._load_model

fiftyone.utils.sam2.SegmentAnything2ImageModel.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2ImageModel._load_predictor

fiftyone.utils.sam2.SegmentAnything2ImageModel.html#_load_predictor

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2ImageModel._forward_pass_boxes

fiftyone.utils.sam2.SegmentAnything2ImageModel.html#_forward_pass_boxes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2ImageModel._output_processor

fiftyone.utils.sam2.SegmentAnything2ImageModel.html#_output_processor

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2ImageModel._load_auto_generator

fiftyone.utils.sam2.SegmentAnything2ImageModel.html#_load_auto_generator

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel

fiftyone.utils.sam2.SegmentAnything2VideoModel.html

Class

Class

PUBLIC

Wrapper for running Segment Anything 2 inference on videos.
fiftyone.utils.sam2.SegmentAnything2VideoModel.__init__

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel._fields

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#_fields

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel.config

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#config

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel._device

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#_device

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel.ctx

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#ctx

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel.model

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#model

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel._curr_prompt_type

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#_curr_prompt_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel._curr_prompts

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#_curr_prompts

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel._curr_classes

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#_curr_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel._curr_frame_width

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#_curr_frame_width

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel._curr_frame_height

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#_curr_frame_height

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel.media_type

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#media_type

Attribute

Property

PUBLIC

The media type processed by the model.
fiftyone.utils.sam2.SegmentAnything2VideoModel._download_model

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#_download_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel._load_model

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel.predict

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#predict

Function

Method

PUBLIC

Performs prediction on the given data.
fiftyone.utils.sam2.SegmentAnything2VideoModel._get_field

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#_get_field

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel._get_prompt_type

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#_get_prompt_type

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel._get_prompts

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#_get_prompts

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel._forward_pass

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#_forward_pass

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel._forward_pass_boxes

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#_forward_pass_boxes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam2.SegmentAnything2VideoModel._forward_pass_points

fiftyone.utils.sam2.SegmentAnything2VideoModel.html#_forward_pass_points

Function

Method

PRIVATE

Undocumented
fiftyone.utils.sam2.load_fiftyone_video_frames

fiftyone.utils.sam2.html#load_fiftyone_video_frames

Function

Function

PUBLIC

Undocumented
fiftyone.utils.sam2._load_video_frames_monkey_patch

fiftyone.utils.sam2.html#_load_video_frames_monkey_patch

Function

Function

PRIVATE

Undocumented
fiftyone.utils.sama.logger

fiftyone.utils.sama.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.sama.download_sama_coco_dataset_split

fiftyone.utils.sama.html#download_sama_coco_dataset_split

Function

Function

PUBLIC

Utility that downloads full or partial data splits of the COCO dataset with annotation splits found at https://www.sama.com/sama-coco-dataset.
fiftyone.utils.sama._merge_annotations

fiftyone.utils.sama.html#_merge_annotations

Function

Function

PRIVATE

Undocumented
fiftyone.utils.sama._IMAGE_DOWNLOAD_LINKS

fiftyone.utils.sama.html#_IMAGE_DOWNLOAD_LINKS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.sama._SPLIT_SIZES

fiftyone.utils.sama.html#_SPLIT_SIZES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.sama._ANNOTATION_DOWNLOAD_LINKS

fiftyone.utils.sama.html#_ANNOTATION_DOWNLOAD_LINKS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.sama._ANNOTATION_PATHS

fiftyone.utils.sama.html#_ANNOTATION_PATHS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.sama._TEST_INFO_DOWNLOAD_LINK

fiftyone.utils.sama.html#_TEST_INFO_DOWNLOAD_LINK

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.sama._TEST_INFO_PATHS

fiftyone.utils.sama.html#_TEST_INFO_PATHS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.sama._SUPPORTED_LABEL_TYPES

fiftyone.utils.sama.html#_SUPPORTED_LABEL_TYPES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.sama._SUPPORTED_SPLITS

fiftyone.utils.sama.html#_SUPPORTED_SPLITS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.sama._CSV_DELIMITERS

fiftyone.utils.sama.html#_CSV_DELIMITERS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.scale.logger

fiftyone.utils.scale.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.scale.import_from_scale

fiftyone.utils.scale.html#import_from_scale

Function

Function

PUBLIC

Imports the Scale AI labels into the FiftyOne dataset.
fiftyone.utils.scale.export_to_scale

fiftyone.utils.scale.html#export_to_scale

Function

Function

PUBLIC

Exports labels from the FiftyOne samples to Scale AI format.
fiftyone.utils.scale.convert_scale_export_to_import

fiftyone.utils.scale.html#convert_scale_export_to_import

Function

Function

PUBLIC

Converts a Scale AI JSON export generated by export_to_scale into the format expected by import_from_scale.
fiftyone.utils.scale._load_labels

fiftyone.utils.scale.html#_load_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._load_labels_dir

fiftyone.utils.scale.html#_load_labels_dir

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._load_task_labels

fiftyone.utils.scale.html#_load_task_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._get_labels

fiftyone.utils.scale.html#_get_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._get_frame_labels

fiftyone.utils.scale.html#_get_frame_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._to_scale_image_labels

fiftyone.utils.scale.html#_to_scale_image_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._to_scale_video_annotation_labels

fiftyone.utils.scale.html#_to_scale_video_annotation_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._to_scale_video_playback_labels

fiftyone.utils.scale.html#_to_scale_video_playback_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._parse_frame_events

fiftyone.utils.scale.html#_parse_frame_events

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._ingest_event_label

fiftyone.utils.scale.html#_ingest_event_label

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._finalize_events

fiftyone.utils.scale.html#_finalize_events

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._make_event

fiftyone.utils.scale.html#_make_event

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._init_video_box

fiftyone.utils.scale.html#_init_video_box

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._make_video_box_frame

fiftyone.utils.scale.html#_make_video_box_frame

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._to_classification

fiftyone.utils.scale.html#_to_classification

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._get_attributes

fiftyone.utils.scale.html#_get_attributes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._to_detections

fiftyone.utils.scale.html#_to_detections

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._to_polylines

fiftyone.utils.scale.html#_to_polylines

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._to_points

fiftyone.utils.scale.html#_to_points

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._make_base_anno

fiftyone.utils.scale.html#_make_base_anno

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._make_bbox

fiftyone.utils.scale.html#_make_bbox

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._make_point

fiftyone.utils.scale.html#_make_point

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._parse_video_labels

fiftyone.utils.scale.html#_parse_video_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._parse_video_annotation_labels

fiftyone.utils.scale.html#_parse_video_annotation_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._get_frame_numbers

fiftyone.utils.scale.html#_get_frame_numbers

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._parse_video_playback_labels

fiftyone.utils.scale.html#_parse_video_playback_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._parse_video_playback_events

fiftyone.utils.scale.html#_parse_video_playback_events

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._parse_video_playback_objects

fiftyone.utils.scale.html#_parse_video_playback_objects

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._parse_image_labels

fiftyone.utils.scale.html#_parse_image_labels

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._parse_classifications

fiftyone.utils.scale.html#_parse_classifications

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._parse_objects

fiftyone.utils.scale.html#_parse_objects

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._parse_bbox

fiftyone.utils.scale.html#_parse_bbox

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._parse_video_bbox

fiftyone.utils.scale.html#_parse_video_bbox

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._parse_points

fiftyone.utils.scale.html#_parse_points

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._parse_point

fiftyone.utils.scale.html#_parse_point

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._parse_mask

fiftyone.utils.scale.html#_parse_mask

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._download_or_load_json

fiftyone.utils.scale.html#_download_or_load_json

Function

Function

PRIVATE

Undocumented
fiftyone.utils.scale._download_or_load_image

fiftyone.utils.scale.html#_download_or_load_image

Function

Function

PRIVATE

Undocumented
fiftyone.utils.super_gradients.super_gradients

fiftyone.utils.super_gradients.html#super_gradients

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.super_gradients.logger

fiftyone.utils.super_gradients.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.super_gradients.convert_super_gradients_model

fiftyone.utils.super_gradients.html#convert_super_gradients_model

Function

Function

PUBLIC

Converts the given SuperGradients model into a FiftyOne model.
fiftyone.utils.super_gradients._convert_yolo_nas_detection_model

fiftyone.utils.super_gradients.html#_convert_yolo_nas_detection_model

Function

Function

PRIVATE

Undocumented
fiftyone.utils.super_gradients.TorchYoloNasModelConfig

fiftyone.utils.super_gradients.TorchYoloNasModelConfig.html

Class

Class

PUBLIC

Configuration for running a TorchYoloNasModel.
fiftyone.utils.super_gradients.TorchYoloNasModelConfig.model

fiftyone.utils.super_gradients.TorchYoloNasModelConfig.html#model

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.super_gradients.TorchYoloNasModelConfig.yolo_nas_model

fiftyone.utils.super_gradients.TorchYoloNasModelConfig.html#yolo_nas_model

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.super_gradients.TorchYoloNasModelConfig.pretrained

fiftyone.utils.super_gradients.TorchYoloNasModelConfig.html#pretrained

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.super_gradients.TorchYoloNasModelConfig.__init__

fiftyone.utils.super_gradients.TorchYoloNasModelConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.super_gradients.TorchYoloNasModel

fiftyone.utils.super_gradients.TorchYoloNasModel.html

Class

Class

PUBLIC

FiftyOne wrapper around YOLO-NAS from https://github.com/Deci-AI/super-gradients.
fiftyone.utils.super_gradients.TorchYoloNasModel._load_model

fiftyone.utils.super_gradients.TorchYoloNasModel.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.super_gradients.TorchYoloNasModel._convert_bboxes

fiftyone.utils.super_gradients.TorchYoloNasModel.html#_convert_bboxes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.super_gradients.TorchYoloNasModel._generate_detections

fiftyone.utils.super_gradients.TorchYoloNasModel.html#_generate_detections

Function

Method

PRIVATE

Undocumented
fiftyone.utils.super_gradients.TorchYoloNasModel.predict

fiftyone.utils.super_gradients.TorchYoloNasModel.html#predict

Function

Method

PUBLIC

Performs prediction on the given image.
fiftyone.utils.super_gradients.TorchYoloNasModel.predict_all

fiftyone.utils.super_gradients.TorchYoloNasModel.html#predict_all

Function

Method

PUBLIC

Performs prediction on the given batch of images.
fiftyone.utils.tf.logger

fiftyone.utils.tf.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.tf.from_images_dir

fiftyone.utils.tf.html#from_images_dir

Function

Function

PUBLIC

Creates a tf.data.Dataset for the given directory of images.
fiftyone.utils.tf.from_images_patt

fiftyone.utils.tf.html#from_images_patt

Function

Function

PUBLIC

Creates a tf.data.Dataset for the given glob pattern of images.
fiftyone.utils.tf.from_images

fiftyone.utils.tf.html#from_images

Function

Function

PUBLIC

Creates a tf.data.Dataset for the given list of images.
fiftyone.utils.tf.from_image_paths_and_labels

fiftyone.utils.tf.html#from_image_paths_and_labels

Function

Function

PUBLIC

Creates a tf.data.Dataset for an image classification dataset stored as a list of image paths and labels.
fiftyone.utils.tf.from_image_classification_dir_tree

fiftyone.utils.tf.html#from_image_classification_dir_tree

Function

Function

PUBLIC

Creates a tf.data.Dataset for the given image classification dataset directory tree.
fiftyone.utils.tf.from_tf_records

fiftyone.utils.tf.html#from_tf_records

Function

Function

PUBLIC

Creates a tf.data.Dataset for the TFRecords at the given path(s).
fiftyone.utils.tf.write_tf_records

fiftyone.utils.tf.html#write_tf_records

Function

Function

PUBLIC

Writes the given tf.train.Example protos to disk as TFRecords.
fiftyone.utils.tf.TFRecordsWriter

fiftyone.utils.tf.TFRecordsWriter.html

Class

Class

PUBLIC

Class for writing TFRecords to disk.
fiftyone.utils.tf.TFRecordsWriter.num_shards

fiftyone.utils.tf.TFRecordsWriter.html#num_shards

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordsWriter.__init__

fiftyone.utils.tf.TFRecordsWriter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordsWriter.tf_records_path

fiftyone.utils.tf.TFRecordsWriter.html#tf_records_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordsWriter._idx

fiftyone.utils.tf.TFRecordsWriter.html#_idx

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordsWriter._num_shards

fiftyone.utils.tf.TFRecordsWriter.html#_num_shards

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordsWriter._writers

fiftyone.utils.tf.TFRecordsWriter.html#_writers

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordsWriter._writers_context

fiftyone.utils.tf.TFRecordsWriter.html#_writers_context

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordsWriter.__enter__

fiftyone.utils.tf.TFRecordsWriter.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordsWriter.__exit__

fiftyone.utils.tf.TFRecordsWriter.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordsWriter.write

fiftyone.utils.tf.TFRecordsWriter.html#write

Function

Method

PUBLIC

Writres the tf.train.Example proto to disk.
fiftyone.utils.tf.TFRecordSampleParser

fiftyone.utils.tf.TFRecordSampleParser.html

Class

Class

PUBLIC

Base class for sample parsers that ingest tf.train.Example protos containing labeled images.
fiftyone.utils.tf.TFRecordSampleParser.force_rgb

fiftyone.utils.tf.TFRecordSampleParser.html#force_rgb

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordSampleParser._FEATURES

fiftyone.utils.tf.TFRecordSampleParser.html#_FEATURES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordSampleParser.__init__

fiftyone.utils.tf.TFRecordSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordSampleParser._current_features_cache

fiftyone.utils.tf.TFRecordSampleParser.html#_current_features_cache

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordSampleParser._channels

fiftyone.utils.tf.TFRecordSampleParser.html#_channels

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordSampleParser.get_image

fiftyone.utils.tf.TFRecordSampleParser.html#get_image

Function

Method

PUBLIC

Returns the image from the current sample.
fiftyone.utils.tf.TFRecordSampleParser.get_label

fiftyone.utils.tf.TFRecordSampleParser.html#get_label

Function

Method

PUBLIC

Returns the label for the current sample.
fiftyone.utils.tf.TFRecordSampleParser.clear_sample

fiftyone.utils.tf.TFRecordSampleParser.html#clear_sample

Function

Method

PUBLIC

Clears the current sample.
fiftyone.utils.tf.TFRecordSampleParser._current_features

fiftyone.utils.tf.TFRecordSampleParser.html#_current_features

Attribute

Property

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordSampleParser._parse_features

fiftyone.utils.tf.TFRecordSampleParser.html#_parse_features

Function

Method

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordSampleParser._parse_image

fiftyone.utils.tf.TFRecordSampleParser.html#_parse_image

Function

Method

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordSampleParser._parse_label

fiftyone.utils.tf.TFRecordSampleParser.html#_parse_label

Function

Method

PRIVATE

Undocumented
fiftyone.utils.tf.TFImageClassificationSampleParser

fiftyone.utils.tf.TFImageClassificationSampleParser.html

Class

Class

PUBLIC

Parser for image classification samples stored as TFRecords.
fiftyone.utils.tf.TFImageClassificationSampleParser._FEATURES

fiftyone.utils.tf.TFImageClassificationSampleParser.html#_FEATURES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.tf.TFImageClassificationSampleParser.label_cls

fiftyone.utils.tf.TFImageClassificationSampleParser.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser.
fiftyone.utils.tf.TFImageClassificationSampleParser.has_image_path

fiftyone.utils.tf.TFImageClassificationSampleParser.html#has_image_path

Attribute

Property

PUBLIC

Whether this parser produces paths to images on disk for samples that it parses.
fiftyone.utils.tf.TFImageClassificationSampleParser.has_image_metadata

fiftyone.utils.tf.TFImageClassificationSampleParser.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.ImageMetadata instances for samples that it parses.
fiftyone.utils.tf.TFImageClassificationSampleParser.get_image_metadata

fiftyone.utils.tf.TFImageClassificationSampleParser.html#get_image_metadata

Function

Method

PUBLIC

Returns the image metadata for the current sample.
fiftyone.utils.tf.TFImageClassificationSampleParser._parse_image

fiftyone.utils.tf.TFImageClassificationSampleParser.html#_parse_image

Function

Method

PRIVATE

Undocumented
fiftyone.utils.tf.TFImageClassificationSampleParser._parse_image_metadata

fiftyone.utils.tf.TFImageClassificationSampleParser.html#_parse_image_metadata

Function

Method

PRIVATE

Undocumented
fiftyone.utils.tf.TFImageClassificationSampleParser._parse_label

fiftyone.utils.tf.TFImageClassificationSampleParser.html#_parse_label

Function

Method

PRIVATE

Undocumented
fiftyone.utils.tf.TFObjectDetectionSampleParser

fiftyone.utils.tf.TFObjectDetectionSampleParser.html

Class

Class

PUBLIC

Parser for samples in TF Object Detection API format.
fiftyone.utils.tf.TFObjectDetectionSampleParser._FEATURES

fiftyone.utils.tf.TFObjectDetectionSampleParser.html#_FEATURES

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.tf.TFObjectDetectionSampleParser.label_cls

fiftyone.utils.tf.TFObjectDetectionSampleParser.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this parser.
fiftyone.utils.tf.TFObjectDetectionSampleParser.has_image_path

fiftyone.utils.tf.TFObjectDetectionSampleParser.html#has_image_path

Attribute

Property

PUBLIC

Whether this parser produces paths to images on disk for samples that it parses.
fiftyone.utils.tf.TFObjectDetectionSampleParser.has_image_metadata

fiftyone.utils.tf.TFObjectDetectionSampleParser.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this parser produces fiftyone.core.metadata.ImageMetadata instances for samples that it parses.
fiftyone.utils.tf.TFObjectDetectionSampleParser.get_image_metadata

fiftyone.utils.tf.TFObjectDetectionSampleParser.html#get_image_metadata

Function

Method

PUBLIC

Returns the image metadata for the current sample.
fiftyone.utils.tf.TFObjectDetectionSampleParser._parse_image

fiftyone.utils.tf.TFObjectDetectionSampleParser.html#_parse_image

Function

Method

PRIVATE

Undocumented
fiftyone.utils.tf.TFObjectDetectionSampleParser._parse_image_metadata

fiftyone.utils.tf.TFObjectDetectionSampleParser.html#_parse_image_metadata

Function

Method

PRIVATE

Undocumented
fiftyone.utils.tf.TFObjectDetectionSampleParser._parse_label

fiftyone.utils.tf.TFObjectDetectionSampleParser.html#_parse_label

Function

Method

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter

fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.html

Class

Class

PUBLIC

Base class for fiftyone.utils.data.importers.LabeledImageDatasetImporter instances that import tf.train.Example protos containing labeled images.
fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.tf_records_path

fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.html#tf_records_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.images_dir

fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.html#images_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.image_format

fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.force_rgb

fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.html#force_rgb

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.__init__

fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter._sample_parser

fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.html#_sample_parser

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter._dataset_ingestor

fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.html#_dataset_ingestor

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter._iter_dataset_ingestor

fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.html#_iter_dataset_ingestor

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.__iter__

fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.__next__

fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.has_dataset_info

fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.has_image_metadata

fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.setup

fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.close

fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been imported.
fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter._make_sample_parser

fiftyone.utils.tf.TFRecordsLabeledImageDatasetImporter.html#_make_sample_parser

Function

Method

PRIVATE

Returns a TFRecordSampleParser instance for parsing TFRecords read by this importer.
fiftyone.utils.tf.TFImageClassificationDatasetImporter

fiftyone.utils.tf.TFImageClassificationDatasetImporter.html

Class

Class

PUBLIC

Importer for TF image classification datasets stored on disk.
fiftyone.utils.tf.TFImageClassificationDatasetImporter.label_cls

fiftyone.utils.tf.TFImageClassificationDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.tf.TFImageClassificationDatasetImporter._make_sample_parser

fiftyone.utils.tf.TFImageClassificationDatasetImporter.html#_make_sample_parser

Function

Method

PRIVATE

Returns a TFRecordSampleParser instance for parsing TFRecords read by this importer.
fiftyone.utils.tf.TFObjectDetectionDatasetImporter

fiftyone.utils.tf.TFObjectDetectionDatasetImporter.html

Class

Class

PUBLIC

Importer for TF detection datasets stored on disk.
fiftyone.utils.tf.TFObjectDetectionDatasetImporter.label_cls

fiftyone.utils.tf.TFObjectDetectionDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.tf.TFObjectDetectionDatasetImporter._make_sample_parser

fiftyone.utils.tf.TFObjectDetectionDatasetImporter.html#_make_sample_parser

Function

Method

PRIVATE

Returns a TFRecordSampleParser instance for parsing TFRecords read by this importer.
fiftyone.utils.tf.TFRecordsDatasetExporter

fiftyone.utils.tf.TFRecordsDatasetExporter.html

Class

Class

PUBLIC

Base class for fiftyone.utils.data.exporters.LabeledImageDatasetExporter instances that export labeled images as TFRecords datasets on disk.
fiftyone.utils.tf.TFRecordsDatasetExporter.tf_records_path

fiftyone.utils.tf.TFRecordsDatasetExporter.html#tf_records_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordsDatasetExporter.num_shards

fiftyone.utils.tf.TFRecordsDatasetExporter.html#num_shards

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordsDatasetExporter.image_format

fiftyone.utils.tf.TFRecordsDatasetExporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordsDatasetExporter.force_rgb

fiftyone.utils.tf.TFRecordsDatasetExporter.html#force_rgb

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordsDatasetExporter.__init__

fiftyone.utils.tf.TFRecordsDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.tf.TFRecordsDatasetExporter._example_generator

fiftyone.utils.tf.TFRecordsDatasetExporter.html#_example_generator

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordsDatasetExporter._filename_maker

fiftyone.utils.tf.TFRecordsDatasetExporter.html#_filename_maker

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordsDatasetExporter._tf_records_writer

fiftyone.utils.tf.TFRecordsDatasetExporter.html#_tf_records_writer

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.tf.TFRecordsDatasetExporter.requires_image_metadata

fiftyone.utils.tf.TFRecordsDatasetExporter.html#requires_image_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.
fiftyone.utils.tf.TFRecordsDatasetExporter.setup

fiftyone.utils.tf.TFRecordsDatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.tf.TFRecordsDatasetExporter.export_sample

fiftyone.utils.tf.TFRecordsDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.tf.TFRecordsDatasetExporter.close

fiftyone.utils.tf.TFRecordsDatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.tf.TFRecordsDatasetExporter._make_example_generator

fiftyone.utils.tf.TFRecordsDatasetExporter.html#_make_example_generator

Function

Method

PRIVATE

Returns a TFExampleGenerator instance that will generate tf.train.Example protos for this exporter.
fiftyone.utils.tf.TFImageClassificationDatasetExporter

fiftyone.utils.tf.TFImageClassificationDatasetExporter.html

Class

Class

PUBLIC

Exporter that writes an image classification dataset to disk as TFRecords.
fiftyone.utils.tf.TFImageClassificationDatasetExporter.label_cls

fiftyone.utils.tf.TFImageClassificationDatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) exported by this exporter.
fiftyone.utils.tf.TFImageClassificationDatasetExporter._make_example_generator

fiftyone.utils.tf.TFImageClassificationDatasetExporter.html#_make_example_generator

Function

Method

PRIVATE

Returns a TFExampleGenerator instance that will generate tf.train.Example protos for this exporter.
fiftyone.utils.tf.TFObjectDetectionDatasetExporter

fiftyone.utils.tf.TFObjectDetectionDatasetExporter.html

Class

Class

PUBLIC

Exporter that writes an object detection dataset to disk as TFRecords in the TF Object Detection API format.
fiftyone.utils.tf.TFObjectDetectionDatasetExporter.classes

fiftyone.utils.tf.TFObjectDetectionDatasetExporter.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.tf.TFObjectDetectionDatasetExporter.__init__

fiftyone.utils.tf.TFObjectDetectionDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.tf.TFObjectDetectionDatasetExporter.label_cls

fiftyone.utils.tf.TFObjectDetectionDatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) exported by this exporter.
fiftyone.utils.tf.TFObjectDetectionDatasetExporter._make_example_generator

fiftyone.utils.tf.TFObjectDetectionDatasetExporter.html#_make_example_generator

Function

Method

PRIVATE

Returns a TFExampleGenerator instance that will generate tf.train.Example protos for this exporter.
fiftyone.utils.tf.TFExampleGenerator

fiftyone.utils.tf.TFExampleGenerator.html

Class

Class

PUBLIC

Base class for sample writers that emit tf.train.Example protos.
fiftyone.utils.tf.TFExampleGenerator.force_rgb

fiftyone.utils.tf.TFExampleGenerator.html#force_rgb

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.tf.TFExampleGenerator.__init__

fiftyone.utils.tf.TFExampleGenerator.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.tf.TFExampleGenerator.make_tf_example

fiftyone.utils.tf.TFExampleGenerator.html#make_tf_example

Function

Method

PUBLIC

Makes a tf.train.Example for the given data.
fiftyone.utils.tf.TFExampleGenerator._parse_image_or_path

fiftyone.utils.tf.TFExampleGenerator.html#_parse_image_or_path

Function

Method

PRIVATE

Undocumented
fiftyone.utils.tf.TFImageClassificationExampleGenerator

fiftyone.utils.tf.TFImageClassificationExampleGenerator.html

Class

Class

PUBLIC

Class for generating tf.train.Example protos for samples in TF image classification format.
fiftyone.utils.tf.TFImageClassificationExampleGenerator.make_tf_example

fiftyone.utils.tf.TFImageClassificationExampleGenerator.html#make_tf_example

Function

Method

PUBLIC

Makes a tf.train.Example for the given data.
fiftyone.utils.tf.TFObjectDetectionExampleGenerator

fiftyone.utils.tf.TFObjectDetectionExampleGenerator.html

Class

Class

PUBLIC

Class for generating tf.train.Example protos for samples in TF Object Detection API format.
fiftyone.utils.tf.TFObjectDetectionExampleGenerator.classes

fiftyone.utils.tf.TFObjectDetectionExampleGenerator.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.tf.TFObjectDetectionExampleGenerator.__init__

fiftyone.utils.tf.TFObjectDetectionExampleGenerator.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.tf.TFObjectDetectionExampleGenerator._dynamic_classes

fiftyone.utils.tf.TFObjectDetectionExampleGenerator.html#_dynamic_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.tf.TFObjectDetectionExampleGenerator._labels_map_rev

fiftyone.utils.tf.TFObjectDetectionExampleGenerator.html#_labels_map_rev

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.tf.TFObjectDetectionExampleGenerator.make_tf_example

fiftyone.utils.tf.TFObjectDetectionExampleGenerator.html#make_tf_example

Function

Method

PUBLIC

Makes a tf.train.Example for the given data.
fiftyone.utils.tf._get_classes_for_detections

fiftyone.utils.tf.html#_get_classes_for_detections

Function

Function

PRIVATE

Undocumented
fiftyone.utils.tf._to_labels_map_rev

fiftyone.utils.tf.html#_to_labels_map_rev

Function

Function

PRIVATE

Undocumented
fiftyone.utils.tf._parse_image_tf

fiftyone.utils.tf.html#_parse_image_tf

Function

Function

PRIVATE

Undocumented
fiftyone.utils.tf._bytes_feature

fiftyone.utils.tf.html#_bytes_feature

Function

Function

PRIVATE

Undocumented
fiftyone.utils.tf._bytes_list_feature

fiftyone.utils.tf.html#_bytes_list_feature

Function

Function

PRIVATE

Undocumented
fiftyone.utils.tf._float_feature

fiftyone.utils.tf.html#_float_feature

Function

Function

PRIVATE

Undocumented
fiftyone.utils.tf._float_list_feature

fiftyone.utils.tf.html#_float_list_feature

Function

Function

PRIVATE

Undocumented
fiftyone.utils.tf._int64_feature

fiftyone.utils.tf.html#_int64_feature

Function

Function

PRIVATE

Undocumented
fiftyone.utils.tf._int64_list_feature

fiftyone.utils.tf.html#_int64_list_feature

Function

Function

PRIVATE

Undocumented
fiftyone.utils.torch.logger

fiftyone.utils.torch.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.torch.load_torch_hub_image_model

fiftyone.utils.torch.html#load_torch_hub_image_model

Function

Function

PUBLIC

Loads an image model from PyTorch Hub as a TorchImageModel.
fiftyone.utils.torch.load_torch_hub_raw_model

fiftyone.utils.torch.html#load_torch_hub_raw_model

Function

Function

PUBLIC

Loads a raw model from PyTorch Hub as a torch:torch.nn.Module.
fiftyone.utils.torch.find_torch_hub_requirements

fiftyone.utils.torch.html#find_torch_hub_requirements

Function

Function

PUBLIC

Locates the requirements.txt file on disk associated with a downloaded PyTorch Hub model.
fiftyone.utils.torch.load_torch_hub_requirements

fiftyone.utils.torch.html#load_torch_hub_requirements

Function

Function

PUBLIC

Loads the package requirements from the requirements.txt file on disk associated with a downloaded PyTorch Hub model.
fiftyone.utils.torch._strip_comments

fiftyone.utils.torch.html#_strip_comments

Function

Function

PRIVATE

Undocumented
fiftyone.utils.torch.install_torch_hub_requirements

fiftyone.utils.torch.html#install_torch_hub_requirements

Function

Function

PUBLIC

Installs the package requirements from the requirements.txt file on disk associated with a downloaded PyTorch Hub model.
fiftyone.utils.torch.ensure_torch_hub_requirements

fiftyone.utils.torch.html#ensure_torch_hub_requirements

Function

Function

PUBLIC

Verifies that the package requirements from the requirements.txt file on disk associated with a downloaded PyTorch Hub model are installed.
fiftyone.utils.torch.TorchEmbeddingsMixin

fiftyone.utils.torch.TorchEmbeddingsMixin.html

Class

Class

PUBLIC

Mixin for Torch models that can generate embeddings.
fiftyone.utils.torch.TorchEmbeddingsMixin.__init__

fiftyone.utils.torch.TorchEmbeddingsMixin.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.TorchEmbeddingsMixin._model

fiftyone.utils.torch.TorchEmbeddingsMixin.html#_model

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchEmbeddingsMixin._embeddings_layer

fiftyone.utils.torch.TorchEmbeddingsMixin.html#_embeddings_layer

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchEmbeddingsMixin._as_feature_extractor

fiftyone.utils.torch.TorchEmbeddingsMixin.html#_as_feature_extractor

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchEmbeddingsMixin.has_embeddings

fiftyone.utils.torch.TorchEmbeddingsMixin.html#has_embeddings

Attribute

Property

PUBLIC

Whether this instance has embeddings.
fiftyone.utils.torch.TorchEmbeddingsMixin.embed

fiftyone.utils.torch.TorchEmbeddingsMixin.html#embed

Function

Method

PUBLIC

Generates an embedding for the given data.
fiftyone.utils.torch.TorchEmbeddingsMixin.embed_all

fiftyone.utils.torch.TorchEmbeddingsMixin.html#embed_all

Function

Method

PUBLIC

Generates embeddings for the given iterable of data.
fiftyone.utils.torch.TorchEmbeddingsMixin.get_embeddings

fiftyone.utils.torch.TorchEmbeddingsMixin.html#get_embeddings

Function

Method

PUBLIC

Returns the embeddings generated by the last forward pass of the model.
fiftyone.utils.torch.TorchEmbeddingsMixin._predict_all

fiftyone.utils.torch.TorchEmbeddingsMixin.html#_predict_all

Function

Method

PRIVATE

Applies a forward pass to the given iterable of data and returns the raw model output with no processing applied.
fiftyone.utils.torch.TorchImageModelConfig

fiftyone.utils.torch.TorchImageModelConfig.html

Class

Class

PUBLIC

Configuration for running a TorchImageModel.
fiftyone.utils.torch.TorchImageModelConfig.model

fiftyone.utils.torch.TorchImageModelConfig.html#model

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.entrypoint_fcn

fiftyone.utils.torch.TorchImageModelConfig.html#entrypoint_fcn

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.entrypoint_args

fiftyone.utils.torch.TorchImageModelConfig.html#entrypoint_args

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.transforms

fiftyone.utils.torch.TorchImageModelConfig.html#transforms

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.transforms_fcn

fiftyone.utils.torch.TorchImageModelConfig.html#transforms_fcn

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.transforms_args

fiftyone.utils.torch.TorchImageModelConfig.html#transforms_args

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.ragged_batches

fiftyone.utils.torch.TorchImageModelConfig.html#ragged_batches

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.raw_inputs

fiftyone.utils.torch.TorchImageModelConfig.html#raw_inputs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.output_processor

fiftyone.utils.torch.TorchImageModelConfig.html#output_processor

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.output_processor_cls

fiftyone.utils.torch.TorchImageModelConfig.html#output_processor_cls

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.output_processor_args

fiftyone.utils.torch.TorchImageModelConfig.html#output_processor_args

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.confidence_thresh

fiftyone.utils.torch.TorchImageModelConfig.html#confidence_thresh

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.classes

fiftyone.utils.torch.TorchImageModelConfig.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.labels_string

fiftyone.utils.torch.TorchImageModelConfig.html#labels_string

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.labels_path

fiftyone.utils.torch.TorchImageModelConfig.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.mask_targets

fiftyone.utils.torch.TorchImageModelConfig.html#mask_targets

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.mask_targets_path

fiftyone.utils.torch.TorchImageModelConfig.html#mask_targets_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.skeleton

fiftyone.utils.torch.TorchImageModelConfig.html#skeleton

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.image_min_size

fiftyone.utils.torch.TorchImageModelConfig.html#image_min_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.image_min_dim

fiftyone.utils.torch.TorchImageModelConfig.html#image_min_dim

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.image_max_size

fiftyone.utils.torch.TorchImageModelConfig.html#image_max_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.image_max_dim

fiftyone.utils.torch.TorchImageModelConfig.html#image_max_dim

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.image_size

fiftyone.utils.torch.TorchImageModelConfig.html#image_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.image_dim

fiftyone.utils.torch.TorchImageModelConfig.html#image_dim

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.image_patch_size

fiftyone.utils.torch.TorchImageModelConfig.html#image_patch_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.image_mean

fiftyone.utils.torch.TorchImageModelConfig.html#image_mean

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.image_std

fiftyone.utils.torch.TorchImageModelConfig.html#image_std

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.embeddings_layer

fiftyone.utils.torch.TorchImageModelConfig.html#embeddings_layer

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.as_feature_extractor

fiftyone.utils.torch.TorchImageModelConfig.html#as_feature_extractor

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.use_half_precision

fiftyone.utils.torch.TorchImageModelConfig.html#use_half_precision

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.cudnn_benchmark

fiftyone.utils.torch.TorchImageModelConfig.html#cudnn_benchmark

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.device

fiftyone.utils.torch.TorchImageModelConfig.html#device

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModelConfig.__init__

fiftyone.utils.torch.TorchImageModelConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModel

fiftyone.utils.torch.TorchImageModel.html

Class

Class

PUBLIC

Wrapper for evaluating a Torch model on images.
fiftyone.utils.torch.TorchImageModel.__init__

fiftyone.utils.torch.TorchImageModel.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModel.config

fiftyone.utils.torch.TorchImageModel.html#config

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModel._device

fiftyone.utils.torch.TorchImageModel.html#_device

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._using_gpu

fiftyone.utils.torch.TorchImageModel.html#_using_gpu

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._using_half_precision

fiftyone.utils.torch.TorchImageModel.html#_using_half_precision

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._no_grad

fiftyone.utils.torch.TorchImageModel.html#_no_grad

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._benchmark_orig

fiftyone.utils.torch.TorchImageModel.html#_benchmark_orig

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._model

fiftyone.utils.torch.TorchImageModel.html#_model

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._transforms

fiftyone.utils.torch.TorchImageModel.html#_transforms

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._ragged_batches

fiftyone.utils.torch.TorchImageModel.html#_ragged_batches

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._preprocess

fiftyone.utils.torch.TorchImageModel.html#_preprocess

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._classes

fiftyone.utils.torch.TorchImageModel.html#_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._mask_targets

fiftyone.utils.torch.TorchImageModel.html#_mask_targets

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._skeleton

fiftyone.utils.torch.TorchImageModel.html#_skeleton

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._output_processor

fiftyone.utils.torch.TorchImageModel.html#_output_processor

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel.__enter__

fiftyone.utils.torch.TorchImageModel.html#__enter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModel.__exit__

fiftyone.utils.torch.TorchImageModel.html#__exit__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModel.media_type

fiftyone.utils.torch.TorchImageModel.html#media_type

Attribute

Property

PUBLIC

The media type processed by the model.
fiftyone.utils.torch.TorchImageModel.has_logits

fiftyone.utils.torch.TorchImageModel.html#has_logits

Attribute

Property

PUBLIC

Whether this instance can generate logits.
fiftyone.utils.torch.TorchImageModel.ragged_batches

fiftyone.utils.torch.TorchImageModel.html#ragged_batches

Attribute

Property

PUBLIC

Whether transforms may return tensors of different sizes. If True, then passing ragged lists of images to predict_all may not be not allowed.
fiftyone.utils.torch.TorchImageModel.transforms

fiftyone.utils.torch.TorchImageModel.html#transforms

Attribute

Property

PUBLIC

A torchvision.transforms function that will be applied to each input before prediction, if any.
fiftyone.utils.torch.TorchImageModel.preprocess

fiftyone.utils.torch.TorchImageModel.html#preprocess

Attribute

Property

PUBLIC

Whether to apply preprocessing transforms for inference, if any.
fiftyone.utils.torch.TorchImageModel.preprocess.setter

fiftyone.utils.torch.TorchImageModel.html#preprocess.setter

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageModel.using_gpu

fiftyone.utils.torch.TorchImageModel.html#using_gpu

Attribute

Property

PUBLIC

Whether the model is using GPU.
fiftyone.utils.torch.TorchImageModel.device

fiftyone.utils.torch.TorchImageModel.html#device

Attribute

Property

PUBLIC

The torch:torch.torch.device that the model is using.
fiftyone.utils.torch.TorchImageModel.using_half_precision

fiftyone.utils.torch.TorchImageModel.html#using_half_precision

Attribute

Property

PUBLIC

Whether the model is using half precision.
fiftyone.utils.torch.TorchImageModel.classes

fiftyone.utils.torch.TorchImageModel.html#classes

Attribute

Property

PUBLIC

The list of class labels for the model, if known.
fiftyone.utils.torch.TorchImageModel.num_classes

fiftyone.utils.torch.TorchImageModel.html#num_classes

Attribute

Property

PUBLIC

The number of classes for the model, if known.
fiftyone.utils.torch.TorchImageModel.mask_targets

fiftyone.utils.torch.TorchImageModel.html#mask_targets

Attribute

Property

PUBLIC

The mask targets for the model, if any.
fiftyone.utils.torch.TorchImageModel.skeleton

fiftyone.utils.torch.TorchImageModel.html#skeleton

Attribute

Property

PUBLIC

The keypoint skeleton for the model, if any.
fiftyone.utils.torch.TorchImageModel.predict

fiftyone.utils.torch.TorchImageModel.html#predict

Function

Method

PUBLIC

Performs prediction on the given image.
fiftyone.utils.torch.TorchImageModel.predict_all

fiftyone.utils.torch.TorchImageModel.html#predict_all

Function

Method

PUBLIC

Performs prediction on the given batch of images.
fiftyone.utils.torch.TorchImageModel._predict_all

fiftyone.utils.torch.TorchImageModel.html#_predict_all

Function

Method

PRIVATE

Applies a forward pass to the given iterable of data and returns the raw model output with no processing applied.
fiftyone.utils.torch.TorchImageModel._forward_pass

fiftyone.utils.torch.TorchImageModel.html#_forward_pass

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._parse_classes

fiftyone.utils.torch.TorchImageModel.html#_parse_classes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._parse_mask_targets

fiftyone.utils.torch.TorchImageModel.html#_parse_mask_targets

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._parse_skeleton

fiftyone.utils.torch.TorchImageModel.html#_parse_skeleton

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._download_model

fiftyone.utils.torch.TorchImageModel.html#_download_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._load_model

fiftyone.utils.torch.TorchImageModel.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._build_transforms

fiftyone.utils.torch.TorchImageModel.html#_build_transforms

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._load_transforms

fiftyone.utils.torch.TorchImageModel.html#_load_transforms

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageModel._build_output_processor

fiftyone.utils.torch.TorchImageModel.html#_build_output_processor

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch.TorchSamplesMixin

fiftyone.utils.torch.TorchSamplesMixin.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.torch.TorchSamplesMixin.predict

fiftyone.utils.torch.TorchSamplesMixin.html#predict

Function

Method

PUBLIC

Performs prediction on the given data.
fiftyone.utils.torch.ToPILImage

fiftyone.utils.torch.ToPILImage.html

Class

Class

PUBLIC

Transform that converts a tensor or ndarray to a PIL image, while also allowing PIL images to passthrough.
fiftyone.utils.torch.ToPILImage.__call__

fiftyone.utils.torch.ToPILImage.html#__call__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.MinResize

fiftyone.utils.torch.MinResize.html

Class

Class

PUBLIC

Transform that resizes the PIL image or torch Tensor, if necessary, so that its minimum dimensions are at least the specified size.
fiftyone.utils.torch.MinResize.interpolation

fiftyone.utils.torch.MinResize.html#interpolation

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.MinResize.__init__

fiftyone.utils.torch.MinResize.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.MinResize.min_output_size

fiftyone.utils.torch.MinResize.html#min_output_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.MinResize._kwargs

fiftyone.utils.torch.MinResize.html#_kwargs

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.MinResize.__call__

fiftyone.utils.torch.MinResize.html#__call__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.MaxResize

fiftyone.utils.torch.MaxResize.html

Class

Class

PUBLIC

Transform that resizes the PIL image or torch Tensor, if necessary, so that its maximum dimensions are at most the specified size.
fiftyone.utils.torch.MaxResize.interpolation

fiftyone.utils.torch.MaxResize.html#interpolation

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.MaxResize.__init__

fiftyone.utils.torch.MaxResize.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.MaxResize.max_output_size

fiftyone.utils.torch.MaxResize.html#max_output_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.MaxResize._kwargs

fiftyone.utils.torch.MaxResize.html#_kwargs

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.MaxResize.__call__

fiftyone.utils.torch.MaxResize.html#__call__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.PatchSize

fiftyone.utils.torch.PatchSize.html

Class

Class

PUBLIC

Transform that center crops the PIL image or torch Tensor, if necessary, so that its dimensions are multiples of the specified patch size.
fiftyone.utils.torch.PatchSize.__init__

fiftyone.utils.torch.PatchSize.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.PatchSize.patch_size

fiftyone.utils.torch.PatchSize.html#patch_size

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.PatchSize.__call__

fiftyone.utils.torch.PatchSize.html#__call__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.SaveLayerTensor

fiftyone.utils.torch.SaveLayerTensor.html

Class

Class

PUBLIC

Callback that saves the input/output tensor of the specified layer of a Torch model during each forward() call.
fiftyone.utils.torch.SaveLayerTensor.__init__

fiftyone.utils.torch.SaveLayerTensor.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.SaveLayerTensor._tensor

fiftyone.utils.torch.SaveLayerTensor.html#_tensor

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.SaveLayerTensor._save_input

fiftyone.utils.torch.SaveLayerTensor.html#_save_input

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.SaveLayerTensor.__call__

fiftyone.utils.torch.SaveLayerTensor.html#__call__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.SaveLayerTensor.tensor

fiftyone.utils.torch.SaveLayerTensor.html#tensor

Attribute

Property

PUBLIC

The tensor saved from the last forward() call.
fiftyone.utils.torch.SaveLayerTensor._setup

fiftyone.utils.torch.SaveLayerTensor.html#_setup

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch.OutputProcessor

fiftyone.utils.torch.OutputProcessor.html

Class

Class

PUBLIC

Interface for processing the outputs of Torch models.
fiftyone.utils.torch.OutputProcessor.__init__

fiftyone.utils.torch.OutputProcessor.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.OutputProcessor.__call__

fiftyone.utils.torch.OutputProcessor.html#__call__

Function

Method

PUBLIC

Parses the model output.
fiftyone.utils.torch.ClassifierOutputProcessor

fiftyone.utils.torch.ClassifierOutputProcessor.html

Class

Class

PUBLIC

Output processor for single label classifiers.
fiftyone.utils.torch.ClassifierOutputProcessor.classes

fiftyone.utils.torch.ClassifierOutputProcessor.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.ClassifierOutputProcessor.store_logits

fiftyone.utils.torch.ClassifierOutputProcessor.html#store_logits

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.ClassifierOutputProcessor.__init__

fiftyone.utils.torch.ClassifierOutputProcessor.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.ClassifierOutputProcessor.__call__

fiftyone.utils.torch.ClassifierOutputProcessor.html#__call__

Function

Method

PUBLIC

Parses the model output.
fiftyone.utils.torch.DetectorOutputProcessor

fiftyone.utils.torch.DetectorOutputProcessor.html

Class

Class

PUBLIC

Output processor for object detectors.
fiftyone.utils.torch.DetectorOutputProcessor.classes

fiftyone.utils.torch.DetectorOutputProcessor.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.DetectorOutputProcessor.__init__

fiftyone.utils.torch.DetectorOutputProcessor.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.DetectorOutputProcessor.__call__

fiftyone.utils.torch.DetectorOutputProcessor.html#__call__

Function

Method

PUBLIC

Parses the model output.
fiftyone.utils.torch.DetectorOutputProcessor._parse_output

fiftyone.utils.torch.DetectorOutputProcessor.html#_parse_output

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch.InstanceSegmenterOutputProcessor

fiftyone.utils.torch.InstanceSegmenterOutputProcessor.html

Class

Class

PUBLIC

Output processor for instance segementers.
fiftyone.utils.torch.InstanceSegmenterOutputProcessor.classes

fiftyone.utils.torch.InstanceSegmenterOutputProcessor.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.InstanceSegmenterOutputProcessor.mask_thresh

fiftyone.utils.torch.InstanceSegmenterOutputProcessor.html#mask_thresh

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.InstanceSegmenterOutputProcessor.__init__

fiftyone.utils.torch.InstanceSegmenterOutputProcessor.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.InstanceSegmenterOutputProcessor.__call__

fiftyone.utils.torch.InstanceSegmenterOutputProcessor.html#__call__

Function

Method

PUBLIC

Parses the model output.
fiftyone.utils.torch.InstanceSegmenterOutputProcessor._parse_output

fiftyone.utils.torch.InstanceSegmenterOutputProcessor.html#_parse_output

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch.KeypointDetectorOutputProcessor

fiftyone.utils.torch.KeypointDetectorOutputProcessor.html

Class

Class

PUBLIC

Output processor for keypoint detection models.
fiftyone.utils.torch.KeypointDetectorOutputProcessor.classes

fiftyone.utils.torch.KeypointDetectorOutputProcessor.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.KeypointDetectorOutputProcessor.__init__

fiftyone.utils.torch.KeypointDetectorOutputProcessor.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.KeypointDetectorOutputProcessor.__call__

fiftyone.utils.torch.KeypointDetectorOutputProcessor.html#__call__

Function

Method

PUBLIC

Parses the model output.
fiftyone.utils.torch.KeypointDetectorOutputProcessor._parse_output

fiftyone.utils.torch.KeypointDetectorOutputProcessor.html#_parse_output

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch.SemanticSegmenterOutputProcessor

fiftyone.utils.torch.SemanticSegmenterOutputProcessor.html

Class

Class

PUBLIC

Output processor for semantic segementers.
fiftyone.utils.torch.SemanticSegmenterOutputProcessor.classes

fiftyone.utils.torch.SemanticSegmenterOutputProcessor.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.SemanticSegmenterOutputProcessor.__init__

fiftyone.utils.torch.SemanticSegmenterOutputProcessor.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.SemanticSegmenterOutputProcessor.__call__

fiftyone.utils.torch.SemanticSegmenterOutputProcessor.html#__call__

Function

Method

PUBLIC

Parses the model output.
fiftyone.utils.torch.recommend_num_workers

fiftyone.utils.torch.html#recommend_num_workers

Function

Function

PUBLIC

Recommend a number of workers for running a torch:torch.utils.data.DataLoader.
fiftyone.utils.torch._to_bytes_array

fiftyone.utils.torch.html#_to_bytes_array

Function

Function

PRIVATE

Undocumented
fiftyone.utils.torch._is_string_array

fiftyone.utils.torch.html#_is_string_array

Function

Function

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageDataset

fiftyone.utils.torch.TorchImageDataset.html

Class

Class

PUBLIC

A torch:torch.utils.data.Dataset of images.
fiftyone.utils.torch.TorchImageDataset.image_paths

fiftyone.utils.torch.TorchImageDataset.html#image_paths

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageDataset.sample_ids

fiftyone.utils.torch.TorchImageDataset.html#sample_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageDataset.transform

fiftyone.utils.torch.TorchImageDataset.html#transform

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageDataset.use_numpy

fiftyone.utils.torch.TorchImageDataset.html#use_numpy

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageDataset.force_rgb

fiftyone.utils.torch.TorchImageDataset.html#force_rgb

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageDataset.skip_failures

fiftyone.utils.torch.TorchImageDataset.html#skip_failures

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageDataset.__init__

fiftyone.utils.torch.TorchImageDataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageDataset.__len__

fiftyone.utils.torch.TorchImageDataset.html#__len__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageDataset.__getitem__

fiftyone.utils.torch.TorchImageDataset.html#__getitem__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageDataset.has_sample_ids

fiftyone.utils.torch.TorchImageDataset.html#has_sample_ids

Attribute

Property

PUBLIC

Whether this dataset has sample IDs.
fiftyone.utils.torch.TorchImageDataset._parse_inputs

fiftyone.utils.torch.TorchImageDataset.html#_parse_inputs

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageClassificationDataset

fiftyone.utils.torch.TorchImageClassificationDataset.html

Class

Class

PUBLIC

A torch:torch.utils.data.Dataset for image classification.
fiftyone.utils.torch.TorchImageClassificationDataset.image_paths

fiftyone.utils.torch.TorchImageClassificationDataset.html#image_paths

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageClassificationDataset.targets

fiftyone.utils.torch.TorchImageClassificationDataset.html#targets

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageClassificationDataset.sample_ids

fiftyone.utils.torch.TorchImageClassificationDataset.html#sample_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageClassificationDataset.transform

fiftyone.utils.torch.TorchImageClassificationDataset.html#transform

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageClassificationDataset.use_numpy

fiftyone.utils.torch.TorchImageClassificationDataset.html#use_numpy

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageClassificationDataset.force_rgb

fiftyone.utils.torch.TorchImageClassificationDataset.html#force_rgb

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageClassificationDataset.skip_failures

fiftyone.utils.torch.TorchImageClassificationDataset.html#skip_failures

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageClassificationDataset.__init__

fiftyone.utils.torch.TorchImageClassificationDataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageClassificationDataset._str_targets

fiftyone.utils.torch.TorchImageClassificationDataset.html#_str_targets

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImageClassificationDataset.__len__

fiftyone.utils.torch.TorchImageClassificationDataset.html#__len__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageClassificationDataset.__getitem__

fiftyone.utils.torch.TorchImageClassificationDataset.html#__getitem__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImageClassificationDataset.has_sample_ids

fiftyone.utils.torch.TorchImageClassificationDataset.html#has_sample_ids

Attribute

Property

PUBLIC

Whether this dataset has sample IDs.
fiftyone.utils.torch.TorchImageClassificationDataset._parse_inputs

fiftyone.utils.torch.TorchImageClassificationDataset.html#_parse_inputs

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImagePatchesDataset

fiftyone.utils.torch.TorchImagePatchesDataset.html

Class

Class

PUBLIC

A torch:torch.utils.data.Dataset of image patch tensors extracted from a list of images.
fiftyone.utils.torch.TorchImagePatchesDataset.image_paths

fiftyone.utils.torch.TorchImagePatchesDataset.html#image_paths

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImagePatchesDataset.transform

fiftyone.utils.torch.TorchImagePatchesDataset.html#transform

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImagePatchesDataset.sample_ids

fiftyone.utils.torch.TorchImagePatchesDataset.html#sample_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImagePatchesDataset.ragged_batches

fiftyone.utils.torch.TorchImagePatchesDataset.html#ragged_batches

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImagePatchesDataset.use_numpy

fiftyone.utils.torch.TorchImagePatchesDataset.html#use_numpy

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImagePatchesDataset.force_rgb

fiftyone.utils.torch.TorchImagePatchesDataset.html#force_rgb

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImagePatchesDataset.force_square

fiftyone.utils.torch.TorchImagePatchesDataset.html#force_square

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImagePatchesDataset.alpha

fiftyone.utils.torch.TorchImagePatchesDataset.html#alpha

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImagePatchesDataset.skip_failures

fiftyone.utils.torch.TorchImagePatchesDataset.html#skip_failures

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImagePatchesDataset.__init__

fiftyone.utils.torch.TorchImagePatchesDataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImagePatchesDataset._patch_edges

fiftyone.utils.torch.TorchImagePatchesDataset.html#_patch_edges

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImagePatchesDataset._patches

fiftyone.utils.torch.TorchImagePatchesDataset.html#_patches

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImagePatchesDataset.__len__

fiftyone.utils.torch.TorchImagePatchesDataset.html#__len__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImagePatchesDataset.__getitem__

fiftyone.utils.torch.TorchImagePatchesDataset.html#__getitem__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.torch.TorchImagePatchesDataset.has_sample_ids

fiftyone.utils.torch.TorchImagePatchesDataset.html#has_sample_ids

Attribute

Property

PUBLIC

Whether this dataset has sample IDs.
fiftyone.utils.torch.TorchImagePatchesDataset._extract_patches

fiftyone.utils.torch.TorchImagePatchesDataset.html#_extract_patches

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch.TorchImagePatchesDataset._parse_inputs

fiftyone.utils.torch.TorchImagePatchesDataset.html#_parse_inputs

Function

Method

PRIVATE

Undocumented
fiftyone.utils.torch._to_eta_bbox

fiftyone.utils.torch.html#_to_eta_bbox

Function

Function

PRIVATE

Undocumented
fiftyone.utils.torch._polylines_to_bboxes

fiftyone.utils.torch.html#_polylines_to_bboxes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.torch._polyline_to_bbox

fiftyone.utils.torch.html#_polyline_to_bbox

Function

Function

PRIVATE

Undocumented
fiftyone.utils.torch.from_image_classification_dir_tree

fiftyone.utils.torch.html#from_image_classification_dir_tree

Function

Function

PUBLIC

Creates a torch:torch.utils.data.Dataset for the given image classification dataset directory tree.
fiftyone.utils.torch._load_image

fiftyone.utils.torch.html#_load_image

Function

Function

PRIVATE

Undocumented
fiftyone.utils.tracking.deepsort.dsrt

fiftyone.utils.tracking.deepsort.html#dsrt

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.tracking.deepsort.logger

fiftyone.utils.tracking.deepsort.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.tracking.deepsort.DeepSort

fiftyone.utils.tracking.deepsort.DeepSort.html

Class

Class

PUBLIC

No class docstring; 2/2 static methods documented
fiftyone.utils.tracking.deepsort.DeepSort.track

fiftyone.utils.tracking.deepsort.DeepSort.html#track

Function

Static Method

PUBLIC

Performs object tracking using the DeepSort algorithm on the given video samples.
fiftyone.utils.tracking.deepsort.DeepSort.track_sample

fiftyone.utils.tracking.deepsort.DeepSort.html#track_sample

Function

Static Method

PUBLIC

Performs object tracking using the DeepSort algorithm on the given video sample.
fiftyone.zoo.models.MODELS_MANIEST_FILENAME

fiftyone.zoo.models.html#MODELS_MANIEST_FILENAME

Attribute

Constant

PUBLIC

Undocumented
fiftyone.zoo.models._THIS_DIR

fiftyone.zoo.models.html#_THIS_DIR

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.models._BUILTIN_MODELS_MANIFEST_PATT

fiftyone.zoo.models.html#_BUILTIN_MODELS_MANIFEST_PATT

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.models._MODELS

fiftyone.zoo.models.html#_MODELS

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.models.logger

fiftyone.zoo.models.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.zoo.models.list_zoo_models

fiftyone.zoo.models.html#list_zoo_models

Function

Function

PUBLIC

Returns the list of available models in the FiftyOne Model Zoo.
fiftyone.zoo.models._list_zoo_models

fiftyone.zoo.models.html#_list_zoo_models

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models.list_downloaded_zoo_models

fiftyone.zoo.models.html#list_downloaded_zoo_models

Function

Function

PUBLIC

Returns information about the zoo models that have been downloaded.
fiftyone.zoo.models.is_zoo_model_downloaded

fiftyone.zoo.models.html#is_zoo_model_downloaded

Function

Function

PUBLIC

Determines whether the zoo model of the given name is downloaded.
fiftyone.zoo.models.download_zoo_model

fiftyone.zoo.models.html#download_zoo_model

Function

Function

PUBLIC

Downloads the specified model from the FiftyOne Model Zoo.
fiftyone.zoo.models.install_zoo_model_requirements

fiftyone.zoo.models.html#install_zoo_model_requirements

Function

Function

PUBLIC

Installs any package requirements for the specified zoo model.
fiftyone.zoo.models.ensure_zoo_model_requirements

fiftyone.zoo.models.html#ensure_zoo_model_requirements

Function

Function

PUBLIC

Ensures that the package requirements for the specified zoo model are satisfied.
fiftyone.zoo.models.load_zoo_model

fiftyone.zoo.models.html#load_zoo_model

Function

Function

PUBLIC

Loads the specified model from the FiftyOne Model Zoo.
fiftyone.zoo.models.find_zoo_model

fiftyone.zoo.models.html#find_zoo_model

Function

Function

PUBLIC

Returns the path to the zoo model on disk.
fiftyone.zoo.models.get_zoo_model

fiftyone.zoo.models.html#get_zoo_model

Function

Function

PUBLIC

Returns the ZooModel instance for the specified zoo model.
fiftyone.zoo.models.delete_zoo_model

fiftyone.zoo.models.html#delete_zoo_model

Function

Function

PUBLIC

Deletes the zoo model from local disk, if necessary.
fiftyone.zoo.models.list_zoo_model_sources

fiftyone.zoo.models.html#list_zoo_model_sources

Function

Function

PUBLIC

Returns the list of remote model sources that are registered locally.
fiftyone.zoo.models.register_zoo_model_source

fiftyone.zoo.models.html#register_zoo_model_source

Function

Function

PUBLIC

Registers a remote source of models, if necessary.
fiftyone.zoo.models.delete_zoo_model_source

fiftyone.zoo.models.html#delete_zoo_model_source

Function

Function

PUBLIC

Deletes the specified remote source and all downloaded models associated with it.
fiftyone.zoo.models.HasZooModel

fiftyone.zoo.models.HasZooModel.html

Class

Class

PUBLIC

Mixin class for Config classes of fiftyone.core.models.Model instances whose models are stored in the FiftyOne Model Zoo.
fiftyone.zoo.models.HasZooModel.download_model_if_necessary

fiftyone.zoo.models.HasZooModel.html#download_model_if_necessary

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.models.HasZooModel.model_path

fiftyone.zoo.models.HasZooModel.html#model_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.models.HasZooModel._get_model

fiftyone.zoo.models.HasZooModel.html#_get_model

Function

Class Method

PRIVATE

Undocumented
fiftyone.zoo.models.ZooModel

fiftyone.zoo.models.ZooModel.html

Class

Class

PUBLIC

Class describing a model in the FiftyOne Model Zoo.
fiftyone.zoo.models.ZooModel._REQUIREMENT_ERROR_SUFFIX

fiftyone.zoo.models.ZooModel.html#_REQUIREMENT_ERROR_SUFFIX

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.models.RemoteZooModel

fiftyone.zoo.models.RemoteZooModel.html

Class

Class

PUBLIC

Undocumented
fiftyone.zoo.models.RemoteZooModel.__init__

fiftyone.zoo.models.RemoteZooModel.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.models.RemoteZooModel.manager

fiftyone.zoo.models.RemoteZooModel.html#manager

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.models.RemoteModelManagerConfig

fiftyone.zoo.models.RemoteModelManagerConfig.html

Class

Class

PUBLIC

Undocumented
fiftyone.zoo.models.RemoteModelManagerConfig.__init__

fiftyone.zoo.models.RemoteModelManagerConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.models.RemoteModelManagerConfig.model_name

fiftyone.zoo.models.RemoteModelManagerConfig.html#model_name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.models.RemoteModelManager

fiftyone.zoo.models.RemoteModelManager.html

Class

Class

PUBLIC

Undocumented
fiftyone.zoo.models.RemoteModelManager._download_model

fiftyone.zoo.models.RemoteModelManager.html#_download_model

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.models._download_remote_model

fiftyone.zoo.models.html#_download_remote_model

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models._load_remote_model

fiftyone.zoo.models.html#_load_remote_model

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models._import_zoo_module

fiftyone.zoo.models.html#_import_zoo_module

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models.ZooModelsManifest

fiftyone.zoo.models.ZooModelsManifest.html

Class

Class

PUBLIC

Class that describes the collection of models in the FiftyOne Model Zoo.
fiftyone.zoo.models.RemoteZooModelsManifest

fiftyone.zoo.models.RemoteZooModelsManifest.html

Class

Class

PUBLIC

Class that describes the collection of remotely-sourced models in the FiftyOne Model Zoo.
fiftyone.zoo.models._load_zoo_models_manifest

fiftyone.zoo.models.html#_load_zoo_models_manifest

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models._merge_manifest

fiftyone.zoo.models.html#_merge_manifest

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models._merge_remote_manifest

fiftyone.zoo.models.html#_merge_remote_manifest

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models._iter_model_manifests

fiftyone.zoo.models.html#_iter_model_manifests

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models._normalize_ref

fiftyone.zoo.models.html#_normalize_ref

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models._download_model_metadata

fiftyone.zoo.models.html#_download_model_metadata

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models._download_archive

fiftyone.zoo.models.html#_download_archive

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models._get_model_in_dir

fiftyone.zoo.models.html#_get_model_in_dir

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models._parse_model_identifier

fiftyone.zoo.models.html#_parse_model_identifier

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models._get_model

fiftyone.zoo.models.html#_get_model

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models._get_exact_model

fiftyone.zoo.models.html#_get_exact_model

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models._get_latest_model

fiftyone.zoo.models.html#_get_latest_model

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models._get_cache_key

fiftyone.zoo.models.html#_get_cache_key

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers.torch

fiftyone.utils.transformers.html#torch

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.transformers

fiftyone.utils.transformers.html#transformers

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.logger

fiftyone.utils.transformers.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.DEFAULT_CLASSIFICATION_PATH

fiftyone.utils.transformers.html#DEFAULT_CLASSIFICATION_PATH

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.transformers.DEFAULT_DETECTION_PATH

fiftyone.utils.transformers.html#DEFAULT_DETECTION_PATH

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.transformers.DEFAULT_SEGMENTATION_PATH

fiftyone.utils.transformers.html#DEFAULT_SEGMENTATION_PATH

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.transformers.DEFAULT_DEPTH_ESTIMATION_PATH

fiftyone.utils.transformers.html#DEFAULT_DEPTH_ESTIMATION_PATH

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.transformers.DEFAULT_ZERO_SHOT_CLASSIFICATION_PATH

fiftyone.utils.transformers.html#DEFAULT_ZERO_SHOT_CLASSIFICATION_PATH

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.transformers.DEFAULT_ZERO_SHOT_DETECTION_PATH

fiftyone.utils.transformers.html#DEFAULT_ZERO_SHOT_DETECTION_PATH

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.transformers.convert_transformers_model

fiftyone.utils.transformers.html#convert_transformers_model

Function

Function

PUBLIC

Converts the given Hugging Face transformers model into a FiftyOne model.
fiftyone.utils.transformers._convert_transformer_base_model

fiftyone.utils.transformers.html#_convert_transformer_base_model

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._convert_transformer_for_image_classification

fiftyone.utils.transformers.html#_convert_transformer_for_image_classification

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._convert_transformer_for_object_detection

fiftyone.utils.transformers.html#_convert_transformer_for_object_detection

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._convert_transformer_for_semantic_segmentation

fiftyone.utils.transformers.html#_convert_transformer_for_semantic_segmentation

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._convert_transformer_for_depth_estimation

fiftyone.utils.transformers.html#_convert_transformer_for_depth_estimation

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._convert_zero_shot_transformer_for_image_classification

fiftyone.utils.transformers.html#_convert_zero_shot_transformer_for_image_classification

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._convert_zero_shot_transformer_for_object_detection

fiftyone.utils.transformers.html#_convert_zero_shot_transformer_for_object_detection

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers.get_model_type

fiftyone.utils.transformers.html#get_model_type

Function

Function

PUBLIC

Returns the string model type for the given model.
fiftyone.utils.transformers.to_classification

fiftyone.utils.transformers.html#to_classification

Function

Function

PUBLIC

Converts the Transformers classification results to FiftyOne format.
fiftyone.utils.transformers.to_segmentation

fiftyone.utils.transformers.html#to_segmentation

Function

Function

PUBLIC

Converts the Transformers semantic segmentation results to FiftyOne format.
fiftyone.utils.transformers._create_segmentation

fiftyone.utils.transformers.html#_create_segmentation

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers.to_heatmap

fiftyone.utils.transformers.html#to_heatmap

Function

Function

PUBLIC

Converts the Transformers depth estimation results to FiftyOne format.
fiftyone.utils.transformers._create_heatmap

fiftyone.utils.transformers.html#_create_heatmap

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers.to_detections

fiftyone.utils.transformers.html#to_detections

Function

Function

PUBLIC

Converts the Transformers detection results to FiftyOne format.
fiftyone.utils.transformers._get_class

fiftyone.utils.transformers.html#_get_class

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._to_detections

fiftyone.utils.transformers.html#_to_detections

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._convert_bounding_box

fiftyone.utils.transformers.html#_convert_bounding_box

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerConfig

fiftyone.utils.transformers.FiftyOneTransformerConfig.html

Class

Class

PUBLIC

Configuration for a FiftyOneTransformer.
fiftyone.utils.transformers.FiftyOneTransformerConfig.model

fiftyone.utils.transformers.FiftyOneTransformerConfig.html#model

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerConfig.name_or_path

fiftyone.utils.transformers.FiftyOneTransformerConfig.html#name_or_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerConfig.__init__

fiftyone.utils.transformers.FiftyOneTransformerConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerConfig.device

fiftyone.utils.transformers.FiftyOneTransformerConfig.html#device

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerConfig

fiftyone.utils.transformers.FiftyOneZeroShotTransformerConfig.html

Class

Class

PUBLIC

Configuration for a FiftyOneZeroShotTransformer.
fiftyone.utils.transformers.FiftyOneZeroShotTransformerConfig.classes

fiftyone.utils.transformers.FiftyOneZeroShotTransformerConfig.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerConfig.__init__

fiftyone.utils.transformers.FiftyOneZeroShotTransformerConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerConfig.text_prompt

fiftyone.utils.transformers.FiftyOneZeroShotTransformerConfig.html#text_prompt

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.TransformerEmbeddingsMixin

fiftyone.utils.transformers.TransformerEmbeddingsMixin.html

Class

Class

PUBLIC

Mixin for Transformers that can generate embeddings.
fiftyone.utils.transformers.TransformerEmbeddingsMixin.has_embeddings

fiftyone.utils.transformers.TransformerEmbeddingsMixin.html#has_embeddings

Attribute

Property

PUBLIC

Whether this instance has embeddings.
fiftyone.utils.transformers.TransformerEmbeddingsMixin.embed

fiftyone.utils.transformers.TransformerEmbeddingsMixin.html#embed

Function

Method

PUBLIC

Generates an embedding for the given data.
fiftyone.utils.transformers.TransformerEmbeddingsMixin.embed_all

fiftyone.utils.transformers.TransformerEmbeddingsMixin.html#embed_all

Function

Method

PUBLIC

Generates embeddings for the given iterable of data.
fiftyone.utils.transformers.TransformerEmbeddingsMixin._embed

fiftyone.utils.transformers.TransformerEmbeddingsMixin.html#_embed

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.ZeroShotTransformerEmbeddingsMixin

fiftyone.utils.transformers.ZeroShotTransformerEmbeddingsMixin.html

Class

Class

PUBLIC

Mixin for Transformers that can generate embeddings.
fiftyone.utils.transformers.ZeroShotTransformerEmbeddingsMixin.has_embeddings

fiftyone.utils.transformers.ZeroShotTransformerEmbeddingsMixin.html#has_embeddings

Attribute

Property

PUBLIC

Whether this instance has embeddings.
fiftyone.utils.transformers.ZeroShotTransformerEmbeddingsMixin.embed

fiftyone.utils.transformers.ZeroShotTransformerEmbeddingsMixin.html#embed

Function

Method

PUBLIC

Generates an embedding for the given data.
fiftyone.utils.transformers.ZeroShotTransformerEmbeddingsMixin.embed_all

fiftyone.utils.transformers.ZeroShotTransformerEmbeddingsMixin.html#embed_all

Function

Method

PUBLIC

Generates embeddings for the given iterable of data.
fiftyone.utils.transformers.ZeroShotTransformerEmbeddingsMixin._embed

fiftyone.utils.transformers.ZeroShotTransformerEmbeddingsMixin.html#_embed

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.ZeroShotTransformerPromptMixin

fiftyone.utils.transformers.ZeroShotTransformerPromptMixin.html

Class

Class

PUBLIC

Mixin for Transformers that can perform zero-shot prediction.
fiftyone.utils.transformers.ZeroShotTransformerPromptMixin.can_embed_prompts

fiftyone.utils.transformers.ZeroShotTransformerPromptMixin.html#can_embed_prompts

Attribute

Property

PUBLIC

Whether this instance can generate prompt embeddings.
fiftyone.utils.transformers.ZeroShotTransformerPromptMixin.embed_prompt

fiftyone.utils.transformers.ZeroShotTransformerPromptMixin.html#embed_prompt

Function

Method

PUBLIC

Generates an embedding for the given text prompt.
fiftyone.utils.transformers.ZeroShotTransformerPromptMixin.embed_prompts

fiftyone.utils.transformers.ZeroShotTransformerPromptMixin.html#embed_prompts

Function

Method

PUBLIC

Generates an embedding for the given text prompts.
fiftyone.utils.transformers.ZeroShotTransformerPromptMixin._embed_prompts

fiftyone.utils.transformers.ZeroShotTransformerPromptMixin.html#_embed_prompts

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneTransformer

fiftyone.utils.transformers.FiftyOneTransformer.html

Class

Class

PUBLIC

FiftyOne wrapper around a transformers model.
fiftyone.utils.transformers.FiftyOneTransformer.__init__

fiftyone.utils.transformers.FiftyOneTransformer.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformer.config

fiftyone.utils.transformers.FiftyOneTransformer.html#config

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformer.model

fiftyone.utils.transformers.FiftyOneTransformer.html#model

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformer.device

fiftyone.utils.transformers.FiftyOneTransformer.html#device

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformer.image_processor

fiftyone.utils.transformers.FiftyOneTransformer.html#image_processor

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformer.media_type

fiftyone.utils.transformers.FiftyOneTransformer.html#media_type

Attribute

Property

PUBLIC

The media type processed by the model.
fiftyone.utils.transformers.FiftyOneTransformer.ragged_batches

fiftyone.utils.transformers.FiftyOneTransformer.html#ragged_batches

Attribute

Property

PUBLIC

True/False whether transforms may return tensors of different sizes. If True, then passing ragged lists of data to predict_all is not allowed.
fiftyone.utils.transformers.FiftyOneTransformer.transforms

fiftyone.utils.transformers.FiftyOneTransformer.html#transforms

Attribute

Property

PUBLIC

The preprocessing function that will/must be applied to each input before prediction, or None if no preprocessing is performed.
fiftyone.utils.transformers.FiftyOneTransformer.preprocess

fiftyone.utils.transformers.FiftyOneTransformer.html#preprocess

Attribute

Property

PUBLIC

Whether to apply transforms during inference (True) or to assume that they have already been applied (False).
fiftyone.utils.transformers.FiftyOneTransformer._load_image_processor

fiftyone.utils.transformers.FiftyOneTransformer.html#_load_image_processor

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneTransformer._load_model

fiftyone.utils.transformers.FiftyOneTransformer.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneTransformer.predict

fiftyone.utils.transformers.FiftyOneTransformer.html#predict

Function

Method

PUBLIC

Performs prediction on the given data.
fiftyone.utils.transformers.FiftyOneZeroShotTransformer

fiftyone.utils.transformers.FiftyOneZeroShotTransformer.html

Class

Class

PUBLIC

FiftyOne wrapper around a transformers model.
fiftyone.utils.transformers.FiftyOneZeroShotTransformer.__init__

fiftyone.utils.transformers.FiftyOneZeroShotTransformer.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformer.config

fiftyone.utils.transformers.FiftyOneZeroShotTransformer.html#config

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformer.classes

fiftyone.utils.transformers.FiftyOneZeroShotTransformer.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformer.model

fiftyone.utils.transformers.FiftyOneZeroShotTransformer.html#model

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformer.device

fiftyone.utils.transformers.FiftyOneZeroShotTransformer.html#device

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformer.processor

fiftyone.utils.transformers.FiftyOneZeroShotTransformer.html#processor

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformer._text_prompts

fiftyone.utils.transformers.FiftyOneZeroShotTransformer.html#_text_prompts

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformer.media_type

fiftyone.utils.transformers.FiftyOneZeroShotTransformer.html#media_type

Attribute

Property

PUBLIC

The media type processed by the model.
fiftyone.utils.transformers.FiftyOneZeroShotTransformer.ragged_batches

fiftyone.utils.transformers.FiftyOneZeroShotTransformer.html#ragged_batches

Attribute

Property

PUBLIC

True/False whether transforms may return tensors of different sizes. If True, then passing ragged lists of data to predict_all is not allowed.
fiftyone.utils.transformers.FiftyOneZeroShotTransformer.transforms

fiftyone.utils.transformers.FiftyOneZeroShotTransformer.html#transforms

Attribute

Property

PUBLIC

The preprocessing function that will/must be applied to each input before prediction, or None if no preprocessing is performed.
fiftyone.utils.transformers.FiftyOneZeroShotTransformer.preprocess

fiftyone.utils.transformers.FiftyOneZeroShotTransformer.html#preprocess

Attribute

Property

PUBLIC

Whether to apply transforms during inference (True) or to assume that they have already been applied (False).
fiftyone.utils.transformers.FiftyOneZeroShotTransformer._load_processor

fiftyone.utils.transformers.FiftyOneZeroShotTransformer.html#_load_processor

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformer._load_model

fiftyone.utils.transformers.FiftyOneZeroShotTransformer.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformer._get_text_prompts

fiftyone.utils.transformers.FiftyOneZeroShotTransformer.html#_get_text_prompts

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformer.predict

fiftyone.utils.transformers.FiftyOneZeroShotTransformer.html#predict

Function

Method

PUBLIC

Performs prediction on the given data.
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassificationConfig

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassificationConfig.html

Class

Class

PUBLIC

Configuration for a FiftyOneZeroShotTransformerForImageClassification.
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassificationConfig.name_or_path

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassificationConfig.html#name_or_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassificationConfig.__init__

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassificationConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassification

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassification.html

Class

Class

PUBLIC

FiftyOne wrapper around a transformers model for zero-shot image classification.
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassification._load_model

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassification.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassification._predict_all_from_features

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassification.html#_predict_all_from_features

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassification._predict_all_from_retrieval

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassification.html#_predict_all_from_retrieval

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassification._predict_from_retrieval

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassification.html#_predict_from_retrieval

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassification.predict_all

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassification.html#predict_all

Function

Method

PUBLIC

Performs prediction on the given iterable of data.
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassification.predict

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForImageClassification.html#predict

Function

Method

PUBLIC

Performs prediction on the given data.
fiftyone.utils.transformers.FiftyOneTransformerForImageClassificationConfig

fiftyone.utils.transformers.FiftyOneTransformerForImageClassificationConfig.html

Class

Class

PUBLIC

Configuration for a FiftyOneTransformerForImageClassification.
fiftyone.utils.transformers.FiftyOneTransformerForImageClassificationConfig.name_or_path

fiftyone.utils.transformers.FiftyOneTransformerForImageClassificationConfig.html#name_or_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForImageClassificationConfig.__init__

fiftyone.utils.transformers.FiftyOneTransformerForImageClassificationConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForImageClassification

fiftyone.utils.transformers.FiftyOneTransformerForImageClassification.html

Class

Class

PUBLIC

FiftyOne wrapper around a transformers model for image classification.
fiftyone.utils.transformers.FiftyOneTransformerForImageClassification._load_model

fiftyone.utils.transformers.FiftyOneTransformerForImageClassification.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForImageClassification._predict

fiftyone.utils.transformers.FiftyOneTransformerForImageClassification.html#_predict

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForImageClassification.predict

fiftyone.utils.transformers.FiftyOneTransformerForImageClassification.html#predict

Function

Method

PUBLIC

Performs prediction on the given data.
fiftyone.utils.transformers.FiftyOneTransformerForImageClassification.predict_all

fiftyone.utils.transformers.FiftyOneTransformerForImageClassification.html#predict_all

Function

Method

PUBLIC

Performs prediction on the given iterable of data.
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetectionConfig

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetectionConfig.html

Class

Class

PUBLIC

Configuration for a FiftyOneZeroShotTransformerForObjectDetection.
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetectionConfig.name_or_path

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetectionConfig.html#name_or_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetectionConfig.__init__

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetectionConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.html

Class

Class

PUBLIC

FiftyOne wrapper around a transformers model for zero shot object detection.
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.__init__

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.config

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.html#config

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.classes

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.processor

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.html#processor

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.model

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.html#model

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.device

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.html#device

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection._text_prompts

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.html#_text_prompts

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection._load_processor

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.html#_load_processor

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection._load_model

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection._process_inputs

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.html#_process_inputs

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection._predict

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.html#_predict

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.predict

fiftyone.utils.transformers.FiftyOneZeroShotTransformerForObjectDetection.html#predict

Function

Method

PUBLIC

Performs prediction on the given data.
fiftyone.utils.transformers.FiftyOneTransformerForObjectDetectionConfig

fiftyone.utils.transformers.FiftyOneTransformerForObjectDetectionConfig.html

Class

Class

PUBLIC

Configuration for a FiftyOneTransformerForObjectDetection.
fiftyone.utils.transformers.FiftyOneTransformerForObjectDetectionConfig.name_or_path

fiftyone.utils.transformers.FiftyOneTransformerForObjectDetectionConfig.html#name_or_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForObjectDetectionConfig.__init__

fiftyone.utils.transformers.FiftyOneTransformerForObjectDetectionConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForObjectDetection

fiftyone.utils.transformers.FiftyOneTransformerForObjectDetection.html

Class

Class

PUBLIC

FiftyOne wrapper around a transformers model for object detection.
fiftyone.utils.transformers.FiftyOneTransformerForObjectDetection._load_model

fiftyone.utils.transformers.FiftyOneTransformerForObjectDetection.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForObjectDetection._predict

fiftyone.utils.transformers.FiftyOneTransformerForObjectDetection.html#_predict

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForObjectDetection.predict

fiftyone.utils.transformers.FiftyOneTransformerForObjectDetection.html#predict

Function

Method

PUBLIC

Performs prediction on the given data.
fiftyone.utils.transformers.FiftyOneTransformerForObjectDetection.predict_all

fiftyone.utils.transformers.FiftyOneTransformerForObjectDetection.html#predict_all

Function

Method

PUBLIC

Performs prediction on the given iterable of data.
fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentationConfig

fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentationConfig.html

Class

Class

PUBLIC

Configuration for a FiftyOneTransformerForSemanticSegmentation.
fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentationConfig.name_or_path

fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentationConfig.html#name_or_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentationConfig.__init__

fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentationConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentation

fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentation.html

Class

Class

PUBLIC

FiftyOne wrapper around a transformers model for semantic segmentation.
fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentation._load_model

fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentation.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentation.mask_targets

fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentation.html#mask_targets

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentation._predict

fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentation.html#_predict

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentation.predict

fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentation.html#predict

Function

Method

PUBLIC

Performs prediction on the given data.
fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentation.predict_all

fiftyone.utils.transformers.FiftyOneTransformerForSemanticSegmentation.html#predict_all

Function

Method

PUBLIC

Performs prediction on the given iterable of data.
fiftyone.utils.transformers.FiftyOneTransformerForDepthEstimationConfig

fiftyone.utils.transformers.FiftyOneTransformerForDepthEstimationConfig.html

Class

Class

PUBLIC

Configuration for a FiftyOneTransformerForDepthEstimation.
fiftyone.utils.transformers.FiftyOneTransformerForDepthEstimationConfig.name_or_path

fiftyone.utils.transformers.FiftyOneTransformerForDepthEstimationConfig.html#name_or_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForDepthEstimationConfig.__init__

fiftyone.utils.transformers.FiftyOneTransformerForDepthEstimationConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForDepthEstimation

fiftyone.utils.transformers.FiftyOneTransformerForDepthEstimation.html

Class

Class

PUBLIC

FiftyOne wrapper around a transformers model for depth estimation.
fiftyone.utils.transformers.FiftyOneTransformerForDepthEstimation._load_model

fiftyone.utils.transformers.FiftyOneTransformerForDepthEstimation.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForDepthEstimation._predict

fiftyone.utils.transformers.FiftyOneTransformerForDepthEstimation.html#_predict

Function

Method

PRIVATE

Undocumented
fiftyone.utils.transformers.FiftyOneTransformerForDepthEstimation.predict

fiftyone.utils.transformers.FiftyOneTransformerForDepthEstimation.html#predict

Function

Method

PUBLIC

Performs prediction on the given data.
fiftyone.utils.transformers.FiftyOneTransformerForDepthEstimation.predict_all

fiftyone.utils.transformers.FiftyOneTransformerForDepthEstimation.html#predict_all

Function

Method

PUBLIC

Performs prediction on the given iterable of data.
fiftyone.utils.transformers._has_text_and_image_features

fiftyone.utils.transformers.html#_has_text_and_image_features

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._has_image_text_retrieval

fiftyone.utils.transformers.html#_has_image_text_retrieval

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._has_detection_model

fiftyone.utils.transformers.html#_has_detection_model

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._is_zero_shot_model

fiftyone.utils.transformers.html#_is_zero_shot_model

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._get_model_type_string

fiftyone.utils.transformers.html#_get_model_type_string

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._is_transformer_for_image_classification

fiftyone.utils.transformers.html#_is_transformer_for_image_classification

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._is_transformer_for_object_detection

fiftyone.utils.transformers.html#_is_transformer_for_object_detection

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._is_transformer_for_semantic_segmentation

fiftyone.utils.transformers.html#_is_transformer_for_semantic_segmentation

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._is_transformer_for_depth_estimation

fiftyone.utils.transformers.html#_is_transformer_for_depth_estimation

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._is_transformer_base_model

fiftyone.utils.transformers.html#_is_transformer_base_model

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._get_base_model_name

fiftyone.utils.transformers.html#_get_base_model_name

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._get_model_for_image_text_retrieval

fiftyone.utils.transformers.html#_get_model_for_image_text_retrieval

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._get_image_processor_fallback

fiftyone.utils.transformers.html#_get_image_processor_fallback

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._get_image_processor

fiftyone.utils.transformers.html#_get_image_processor

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._get_processor

fiftyone.utils.transformers.html#_get_processor

Function

Function

PRIVATE

Undocumented
fiftyone.utils.transformers._get_detector_from_processor

fiftyone.utils.transformers.html#_get_detector_from_processor

Function

Function

PRIVATE

Undocumented
fiftyone.utils.ucf101.logger

fiftyone.utils.ucf101.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.ucf101.download_ucf101_dataset

fiftyone.utils.ucf101.html#download_ucf101_dataset

Function

Function

PUBLIC

Downloads and extracts the UCF101 dataset.
fiftyone.utils.ucf101._VIDEOS_DOWNLOAD_LINK

fiftyone.utils.ucf101.html#_VIDEOS_DOWNLOAD_LINK

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.ucf101._SPLITS_DOWNLOAD_LINK

fiftyone.utils.ucf101.html#_SPLITS_DOWNLOAD_LINK

Attribute

Constant

PRIVATE

Undocumented
fiftyone.utils.ucf101._download_videos

fiftyone.utils.ucf101.html#_download_videos

Function

Function

PRIVATE

Undocumented
fiftyone.utils.ucf101._download_splits

fiftyone.utils.ucf101.html#_download_splits

Function

Function

PRIVATE

Undocumented
fiftyone.utils.ucf101._load_split_info

fiftyone.utils.ucf101.html#_load_split_info

Function

Function

PRIVATE

Undocumented
fiftyone.utils.ultralytics.ultralytics

fiftyone.utils.ultralytics.html#ultralytics

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.ultralytics.torch

fiftyone.utils.ultralytics.html#torch

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.ultralytics.convert_ultralytics_model

fiftyone.utils.ultralytics.html#convert_ultralytics_model

Function

Function

PUBLIC

Converts the given Ultralytics model into a FiftyOne model.
fiftyone.utils.ultralytics._extract_track_ids

fiftyone.utils.ultralytics.html#_extract_track_ids

Function

Function

PRIVATE

Get ultralytics track ids if present, else use Nones
fiftyone.utils.ultralytics.to_detections

fiftyone.utils.ultralytics.html#to_detections

Function

Function

PUBLIC

Converts ultralytics.YOLO boxes to FiftyOne format.
fiftyone.utils.ultralytics._to_detections

fiftyone.utils.ultralytics.html#_to_detections

Function

Function

PRIVATE

Undocumented
fiftyone.utils.ultralytics.to_instances

fiftyone.utils.ultralytics.html#to_instances

Function

Function

PUBLIC

Converts ultralytics.YOLO instance segmentations to FiftyOne format.
fiftyone.utils.ultralytics._to_instances

fiftyone.utils.ultralytics.html#_to_instances

Function

Function

PRIVATE

Undocumented
fiftyone.utils.ultralytics.obb_to_polylines

fiftyone.utils.ultralytics.html#obb_to_polylines

Function

Function

PUBLIC

Converts ultralytics.YOLO instance segmentations to FiftyOne format.
fiftyone.utils.ultralytics._obb_to_polylines

fiftyone.utils.ultralytics.html#_obb_to_polylines

Function

Function

PRIVATE

Undocumented
fiftyone.utils.ultralytics.to_polylines

fiftyone.utils.ultralytics.html#to_polylines

Function

Function

PUBLIC

Converts ultralytics.YOLO instance segmentations to FiftyOne format.
fiftyone.utils.ultralytics._to_polylines

fiftyone.utils.ultralytics.html#_to_polylines

Function

Function

PRIVATE

Undocumented
fiftyone.utils.ultralytics.to_keypoints

fiftyone.utils.ultralytics.html#to_keypoints

Function

Function

PUBLIC

Converts ultralytics.YOLO keypoints to FiftyOne format.
fiftyone.utils.ultralytics._to_keypoints

fiftyone.utils.ultralytics.html#_to_keypoints

Function

Function

PRIVATE

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOModelConfig

fiftyone.utils.ultralytics.FiftyOneYOLOModelConfig.html

Class

Class

PUBLIC

Configuration for a FiftyOneYOLOModel.
fiftyone.utils.ultralytics.FiftyOneYOLOModelConfig.model

fiftyone.utils.ultralytics.FiftyOneYOLOModelConfig.html#model

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOModelConfig.model_name

fiftyone.utils.ultralytics.FiftyOneYOLOModelConfig.html#model_name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOModelConfig.model_path

fiftyone.utils.ultralytics.FiftyOneYOLOModelConfig.html#model_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOModelConfig.classes

fiftyone.utils.ultralytics.FiftyOneYOLOModelConfig.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOModelConfig.__init__

fiftyone.utils.ultralytics.FiftyOneYOLOModelConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOModelConfig.device

fiftyone.utils.ultralytics.FiftyOneYOLOModelConfig.html#device

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOModel

fiftyone.utils.ultralytics.FiftyOneYOLOModel.html

Class

Class

PUBLIC

FiftyOne wrapper around an ultralytics.YOLO model.
fiftyone.utils.ultralytics.FiftyOneYOLOModel.__init__

fiftyone.utils.ultralytics.FiftyOneYOLOModel.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOModel.config

fiftyone.utils.ultralytics.FiftyOneYOLOModel.html#config

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOModel.model

fiftyone.utils.ultralytics.FiftyOneYOLOModel.html#model

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOModel.device

fiftyone.utils.ultralytics.FiftyOneYOLOModel.html#device

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOModel._load_model

fiftyone.utils.ultralytics.FiftyOneYOLOModel.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOModel.media_type

fiftyone.utils.ultralytics.FiftyOneYOLOModel.html#media_type

Attribute

Property

PUBLIC

The media type processed by the model.
fiftyone.utils.ultralytics.FiftyOneYOLOModel.ragged_batches

fiftyone.utils.ultralytics.FiftyOneYOLOModel.html#ragged_batches

Attribute

Property

PUBLIC

True/False whether transforms may return tensors of different sizes. If True, then passing ragged lists of data to predict_all is not allowed.
fiftyone.utils.ultralytics.FiftyOneYOLOModel.transforms

fiftyone.utils.ultralytics.FiftyOneYOLOModel.html#transforms

Attribute

Property

PUBLIC

The preprocessing function that will/must be applied to each input before prediction, or None if no preprocessing is performed.
fiftyone.utils.ultralytics.FiftyOneYOLOModel.preprocess

fiftyone.utils.ultralytics.FiftyOneYOLOModel.html#preprocess

Attribute

Property

PUBLIC

Whether to apply transforms during inference (True) or to assume that they have already been applied (False).
fiftyone.utils.ultralytics.FiftyOneYOLOModel._format_predictions

fiftyone.utils.ultralytics.FiftyOneYOLOModel.html#_format_predictions

Function

Method

PRIVATE

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOModel.predict

fiftyone.utils.ultralytics.FiftyOneYOLOModel.html#predict

Function

Method

PUBLIC

Performs prediction on the given data.
fiftyone.utils.ultralytics.FiftyOneYOLODetectionModelConfig

fiftyone.utils.ultralytics.FiftyOneYOLODetectionModelConfig.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLODetectionModel

fiftyone.utils.ultralytics.FiftyOneYOLODetectionModel.html

Class

Class

PUBLIC

FiftyOne wrapper around an Ultralytics YOLO detection model.
fiftyone.utils.ultralytics.FiftyOneYOLODetectionModel.__init__

fiftyone.utils.ultralytics.FiftyOneYOLODetectionModel.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLODetectionModel._format_predictions

fiftyone.utils.ultralytics.FiftyOneYOLODetectionModel.html#_format_predictions

Function

Method

PRIVATE

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLODetectionModel.predict_all

fiftyone.utils.ultralytics.FiftyOneYOLODetectionModel.html#predict_all

Function

Method

PUBLIC

Performs prediction on the given iterable of data.
fiftyone.utils.ultralytics.FiftyOneRTDETRModelConfig

fiftyone.utils.ultralytics.FiftyOneRTDETRModelConfig.html

Class

Class

PUBLIC

Configuration for a FiftyOneRTDETRModel.
fiftyone.utils.ultralytics.FiftyOneRTDETRModelConfig.__init__

fiftyone.utils.ultralytics.FiftyOneRTDETRModelConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneRTDETRModel

fiftyone.utils.ultralytics.FiftyOneRTDETRModel.html

Class

Class

PUBLIC

FiftyOne wrapper around an ultralytics.RTDETR model.
fiftyone.utils.ultralytics.FiftyOneRTDETRModel.__init__

fiftyone.utils.ultralytics.FiftyOneRTDETRModel.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneRTDETRModel.config

fiftyone.utils.ultralytics.FiftyOneRTDETRModel.html#config

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneRTDETRModel.model

fiftyone.utils.ultralytics.FiftyOneRTDETRModel.html#model

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneRTDETRModel._load_model

fiftyone.utils.ultralytics.FiftyOneRTDETRModel.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.utils.ultralytics.FiftyOneRTDETRModel.media_type

fiftyone.utils.ultralytics.FiftyOneRTDETRModel.html#media_type

Attribute

Property

PUBLIC

The media type processed by the model.
fiftyone.utils.ultralytics.FiftyOneRTDETRModel.ragged_batches

fiftyone.utils.ultralytics.FiftyOneRTDETRModel.html#ragged_batches

Attribute

Property

PUBLIC

True/False whether transforms may return tensors of different sizes. If True, then passing ragged lists of data to predict_all is not allowed.
fiftyone.utils.ultralytics.FiftyOneRTDETRModel.transforms

fiftyone.utils.ultralytics.FiftyOneRTDETRModel.html#transforms

Attribute

Property

PUBLIC

The preprocessing function that will/must be applied to each input before prediction, or None if no preprocessing is performed.
fiftyone.utils.ultralytics.FiftyOneRTDETRModel.preprocess

fiftyone.utils.ultralytics.FiftyOneRTDETRModel.html#preprocess

Attribute

Property

PUBLIC

Whether to apply transforms during inference (True) or to assume that they have already been applied (False).
fiftyone.utils.ultralytics.FiftyOneRTDETRModel._format_predictions

fiftyone.utils.ultralytics.FiftyOneRTDETRModel.html#_format_predictions

Function

Method

PRIVATE

Undocumented
fiftyone.utils.ultralytics.FiftyOneRTDETRModel.predict

fiftyone.utils.ultralytics.FiftyOneRTDETRModel.html#predict

Function

Method

PUBLIC

Performs prediction on the given data.
fiftyone.utils.ultralytics.FiftyOneYOLOOBBModelConfig

fiftyone.utils.ultralytics.FiftyOneYOLOOBBModelConfig.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOOBBModel

fiftyone.utils.ultralytics.FiftyOneYOLOOBBModel.html

Class

Class

PUBLIC

FiftyOne wrapper around an Ultralytics YOLO OBB detection model.
fiftyone.utils.ultralytics.FiftyOneYOLOOBBModel._format_predictions

fiftyone.utils.ultralytics.FiftyOneYOLOOBBModel.html#_format_predictions

Function

Method

PRIVATE

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOOBBModel.predict_all

fiftyone.utils.ultralytics.FiftyOneYOLOOBBModel.html#predict_all

Function

Method

PUBLIC

Performs prediction on the given iterable of data.
fiftyone.utils.ultralytics.FiftyOneYOLOSegmentationModelConfig

fiftyone.utils.ultralytics.FiftyOneYOLOSegmentationModelConfig.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOSegmentationModel

fiftyone.utils.ultralytics.FiftyOneYOLOSegmentationModel.html

Class

Class

PUBLIC

FiftyOne wrapper around an Ultralytics YOLO segmentation model.
fiftyone.utils.ultralytics.FiftyOneYOLOSegmentationModel.ragged_batches

fiftyone.utils.ultralytics.FiftyOneYOLOSegmentationModel.html#ragged_batches

Attribute

Property

PUBLIC

True/False whether transforms may return tensors of different sizes. If True, then passing ragged lists of data to predict_all is not allowed.
fiftyone.utils.ultralytics.FiftyOneYOLOSegmentationModel._format_predictions

fiftyone.utils.ultralytics.FiftyOneYOLOSegmentationModel.html#_format_predictions

Function

Method

PRIVATE

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOPoseModelConfig

fiftyone.utils.ultralytics.FiftyOneYOLOPoseModelConfig.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOPoseModel

fiftyone.utils.ultralytics.FiftyOneYOLOPoseModel.html

Class

Class

PUBLIC

FiftyOne wrapper around an Ultralytics YOLO pose model.
fiftyone.utils.ultralytics.FiftyOneYOLOPoseModel._format_predictions

fiftyone.utils.ultralytics.FiftyOneYOLOPoseModel.html#_format_predictions

Function

Method

PRIVATE

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOPoseModel.predict_all

fiftyone.utils.ultralytics.FiftyOneYOLOPoseModel.html#predict_all

Function

Method

PUBLIC

Performs prediction on the given iterable of data.
fiftyone.utils.ultralytics.FiftyOneYOLOClassificationModelConfig

fiftyone.utils.ultralytics.FiftyOneYOLOClassificationModelConfig.html

Class

Class

PUBLIC

Undocumented
fiftyone.utils.ultralytics.FiftyOneYOLOClassificationModel

fiftyone.utils.ultralytics.FiftyOneYOLOClassificationModel.html

Class

Class

PUBLIC

FiftyOne wrapper around an Ultralytics YOLO classification model.
fiftyone.utils.ultralytics.FiftyOneYOLOClassificationModel._format_predictions

fiftyone.utils.ultralytics.FiftyOneYOLOClassificationModel.html#_format_predictions

Function

Method

PRIVATE

Undocumented
fiftyone.utils.ultralytics._convert_yolo_classification_model

fiftyone.utils.ultralytics.html#_convert_yolo_classification_model

Function

Function

PRIVATE

Undocumented
fiftyone.utils.ultralytics._convert_yolo_detection_model

fiftyone.utils.ultralytics.html#_convert_yolo_detection_model

Function

Function

PRIVATE

Undocumented
fiftyone.utils.ultralytics._convert_yolo_obb_model

fiftyone.utils.ultralytics.html#_convert_yolo_obb_model

Function

Function

PRIVATE

Undocumented
fiftyone.utils.ultralytics._convert_yolo_segmentation_model

fiftyone.utils.ultralytics.html#_convert_yolo_segmentation_model

Function

Function

PRIVATE

Undocumented
fiftyone.utils.ultralytics._convert_yolo_pose_model

fiftyone.utils.ultralytics.html#_convert_yolo_pose_model

Function

Function

PRIVATE

Undocumented
fiftyone.utils.ultralytics.UltralyticsOutputProcessor

fiftyone.utils.ultralytics.UltralyticsOutputProcessor.html

Class

Class

PUBLIC

Converts Ultralytics PyTorch Hub model outputs to FiftyOne format.
fiftyone.utils.ultralytics.UltralyticsOutputProcessor.__call__

fiftyone.utils.ultralytics.UltralyticsOutputProcessor.html#__call__

Function

Method

PUBLIC

Parses the model output.
fiftyone.utils.ultralytics.UltralyticsOutputProcessor._to_detections

fiftyone.utils.ultralytics.UltralyticsOutputProcessor.html#_to_detections

Function

Method

PRIVATE

Undocumented
fiftyone.utils.video.logger

fiftyone.utils.video.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.video.extract_clip

fiftyone.utils.video.html#extract_clip

Function

Function

PUBLIC

Extracts the specified clip from the video.
fiftyone.utils.video.reencode_videos

fiftyone.utils.video.html#reencode_videos

Function

Function

PUBLIC

Re-encodes the videos in the sample collection as H.264 MP4s that can be visualized in the FiftyOne App.
fiftyone.utils.video.transform_videos

fiftyone.utils.video.html#transform_videos

Function

Function

PUBLIC

Transforms the videos in the sample collection according to the provided parameters using ffmpeg.
fiftyone.utils.video.sample_videos

fiftyone.utils.video.html#sample_videos

Function

Function

PUBLIC

Samples the videos in the sample collection into directories of per-frame images according to the provided parameters using ffmpeg.
fiftyone.utils.video.reencode_video

fiftyone.utils.video.html#reencode_video

Function

Function

PUBLIC

Re-encodes the video using the H.264 codec.
fiftyone.utils.video.transform_video

fiftyone.utils.video.html#transform_video

Function

Function

PUBLIC

Transforms the video according to the provided parameters using ffmpeg.
fiftyone.utils.video.sample_video

fiftyone.utils.video.html#sample_video

Function

Function

PUBLIC

Samples the video into a directory of per-frame images according to the provided parameters using ffmpeg.
fiftyone.utils.video.sample_frames_uniform

fiftyone.utils.video.html#sample_frames_uniform

Function

Function

PUBLIC

Returns a list of frame numbers sampled uniformly according to the provided parameters.
fiftyone.utils.video.concat_videos

fiftyone.utils.video.html#concat_videos

Function

Function

PUBLIC

Concatenates the given list of videos, in order, into a single video.
fiftyone.utils.video.exact_frame_count

fiftyone.utils.video.html#exact_frame_count

Function

Function

PUBLIC

Returns the exact number of frames in the video.
fiftyone.utils.video._transform_videos

fiftyone.utils.video.html#_transform_videos

Function

Function

PRIVATE

Undocumented
fiftyone.utils.video._transform_video

fiftyone.utils.video.html#_transform_video

Function

Function

PRIVATE

Undocumented
fiftyone.utils.video._parse_parameters

fiftyone.utils.video.html#_parse_parameters

Function

Function

PRIVATE

Undocumented
fiftyone.utils.video._get_outpath

fiftyone.utils.video.html#_get_outpath

Function

Function

PRIVATE

Undocumented
fiftyone.utils.voc.logger

fiftyone.utils.voc.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetImporter

fiftyone.utils.voc.VOCDetectionDatasetImporter.html

Class

Class

PUBLIC

Importer for VOC detection datasets stored on disk.
fiftyone.utils.voc.VOCDetectionDatasetImporter.data_path

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetImporter.labels_path

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetImporter.include_all_data

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#include_all_data

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetImporter.extra_attrs

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#extra_attrs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetImporter.__init__

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetImporter._image_paths_map

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#_image_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetImporter._labels_paths_map

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#_labels_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetImporter._uuids

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetImporter._iter_uuids

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#_iter_uuids

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetImporter._num_samples

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetImporter.__iter__

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetImporter.__len__

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.voc.VOCDetectionDatasetImporter.__next__

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.voc.VOCDetectionDatasetImporter.has_dataset_info

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.voc.VOCDetectionDatasetImporter.has_image_metadata

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.voc.VOCDetectionDatasetImporter.label_cls

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.voc.VOCDetectionDatasetImporter.setup

fiftyone.utils.voc.VOCDetectionDatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.voc.VOCDetectionDatasetExporter

fiftyone.utils.voc.VOCDetectionDatasetExporter.html

Class

Class

PUBLIC

Exporter that writes VOC detection datasets to disk.
fiftyone.utils.voc.VOCDetectionDatasetExporter.data_path

fiftyone.utils.voc.VOCDetectionDatasetExporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetExporter.labels_path

fiftyone.utils.voc.VOCDetectionDatasetExporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetExporter.export_media

fiftyone.utils.voc.VOCDetectionDatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetExporter.rel_dir

fiftyone.utils.voc.VOCDetectionDatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetExporter.include_paths

fiftyone.utils.voc.VOCDetectionDatasetExporter.html#include_paths

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetExporter.image_format

fiftyone.utils.voc.VOCDetectionDatasetExporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetExporter.extra_attrs

fiftyone.utils.voc.VOCDetectionDatasetExporter.html#extra_attrs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetExporter.__init__

fiftyone.utils.voc.VOCDetectionDatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetExporter._writer

fiftyone.utils.voc.VOCDetectionDatasetExporter.html#_writer

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetExporter._media_exporter

fiftyone.utils.voc.VOCDetectionDatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.voc.VOCDetectionDatasetExporter.requires_image_metadata

fiftyone.utils.voc.VOCDetectionDatasetExporter.html#requires_image_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.
fiftyone.utils.voc.VOCDetectionDatasetExporter.label_cls

fiftyone.utils.voc.VOCDetectionDatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) exported by this exporter.
fiftyone.utils.voc.VOCDetectionDatasetExporter.setup

fiftyone.utils.voc.VOCDetectionDatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.voc.VOCDetectionDatasetExporter.export_sample

fiftyone.utils.voc.VOCDetectionDatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.voc.VOCDetectionDatasetExporter.close

fiftyone.utils.voc.VOCDetectionDatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.voc.VOCAnnotation

fiftyone.utils.voc.VOCAnnotation.html

Class

Class

PUBLIC

Class representing a VOC annotations file.
fiftyone.utils.voc.VOCAnnotation.path

fiftyone.utils.voc.VOCAnnotation.html#path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCAnnotation.folder

fiftyone.utils.voc.VOCAnnotation.html#folder

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCAnnotation.filename

fiftyone.utils.voc.VOCAnnotation.html#filename

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCAnnotation.segmented

fiftyone.utils.voc.VOCAnnotation.html#segmented

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCAnnotation.metadata

fiftyone.utils.voc.VOCAnnotation.html#metadata

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCAnnotation.objects

fiftyone.utils.voc.VOCAnnotation.html#objects

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCAnnotation.__init__

fiftyone.utils.voc.VOCAnnotation.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.voc.VOCAnnotation.to_detections

fiftyone.utils.voc.VOCAnnotation.html#to_detections

Function

Method

PUBLIC

Returns a fiftyone.core.labels.Detections representation of the objects in the annotation.
fiftyone.utils.voc.VOCAnnotation.from_labeled_image

fiftyone.utils.voc.VOCAnnotation.html#from_labeled_image

Function

Class Method

PUBLIC

Creates a VOCAnnotation instance for the given labeled image data.
fiftyone.utils.voc.VOCAnnotation.from_xml

fiftyone.utils.voc.VOCAnnotation.html#from_xml

Function

Class Method

PUBLIC

Creates a VOCAnnotation instance from an XML annotations file.
fiftyone.utils.voc.VOCAnnotation.from_dict

fiftyone.utils.voc.VOCAnnotation.html#from_dict

Function

Class Method

PUBLIC

Creates a VOCAnnotation instance from a JSON dict representation.
fiftyone.utils.voc.VOCObject

fiftyone.utils.voc.VOCObject.html

Class

Class

PUBLIC

An object in VOC detection format.
fiftyone.utils.voc.VOCObject.__init__

fiftyone.utils.voc.VOCObject.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.voc.VOCObject.name

fiftyone.utils.voc.VOCObject.html#name

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCObject.bndbox

fiftyone.utils.voc.VOCObject.html#bndbox

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCObject.attributes

fiftyone.utils.voc.VOCObject.html#attributes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCObject.from_annotation_dict

fiftyone.utils.voc.VOCObject.html#from_annotation_dict

Function

Class Method

PUBLIC

Creates a VOCObject from a VOC annotation dict.
fiftyone.utils.voc.VOCObject.from_detection

fiftyone.utils.voc.VOCObject.html#from_detection

Function

Class Method

PUBLIC

Creates a VOCObject from a fiftyone.core.labels.Detection.
fiftyone.utils.voc.VOCObject.to_detection

fiftyone.utils.voc.VOCObject.html#to_detection

Function

Method

PUBLIC

Returns a fiftyone.core.labels.Detection representation of the object.
fiftyone.utils.voc.VOCBoundingBox

fiftyone.utils.voc.VOCBoundingBox.html

Class

Class

PUBLIC

A bounding box in VOC detection format.
fiftyone.utils.voc.VOCBoundingBox.__init__

fiftyone.utils.voc.VOCBoundingBox.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.voc.VOCBoundingBox.xmin

fiftyone.utils.voc.VOCBoundingBox.html#xmin

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCBoundingBox.ymin

fiftyone.utils.voc.VOCBoundingBox.html#ymin

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCBoundingBox.xmax

fiftyone.utils.voc.VOCBoundingBox.html#xmax

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCBoundingBox.ymax

fiftyone.utils.voc.VOCBoundingBox.html#ymax

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCBoundingBox.from_bndbox_dict

fiftyone.utils.voc.VOCBoundingBox.html#from_bndbox_dict

Function

Class Method

PUBLIC

Creates a VOCBoundingBox from a bndbox dict.
fiftyone.utils.voc.VOCBoundingBox.from_detection_format

fiftyone.utils.voc.VOCBoundingBox.html#from_detection_format

Function

Class Method

PUBLIC

Creates a VOCBoundingBox from a bounding box stored in fiftyone.core.labels.Detection format.
fiftyone.utils.voc.VOCBoundingBox.to_detection_format

fiftyone.utils.voc.VOCBoundingBox.html#to_detection_format

Function

Method

PUBLIC

Returns a representation of the bounding box suitable for storing in the bounding_box field of a fiftyone.core.labels.Detection.
fiftyone.utils.voc.VOCAnnotationWriter

fiftyone.utils.voc.VOCAnnotationWriter.html

Class

Class

PUBLIC

Class for writing annotations in VOC format.
fiftyone.utils.voc.VOCAnnotationWriter.__init__

fiftyone.utils.voc.VOCAnnotationWriter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.voc.VOCAnnotationWriter.template

fiftyone.utils.voc.VOCAnnotationWriter.html#template

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.voc.VOCAnnotationWriter.write

fiftyone.utils.voc.VOCAnnotationWriter.html#write

Function

Method

PUBLIC

Writes the annotations to disk.
fiftyone.utils.voc.load_voc_detection_annotations

fiftyone.utils.voc.html#load_voc_detection_annotations

Function

Function

PUBLIC

Loads the VOC detection annotations from the given XML file.
fiftyone.utils.voc.VOC_DETECTION_CLASSES

fiftyone.utils.voc.html#VOC_DETECTION_CLASSES

Attribute

Constant

PUBLIC

Undocumented
fiftyone.utils.voc._ensure_list

fiftyone.utils.voc.html#_ensure_list

Function

Function

PRIVATE

Undocumented
fiftyone.utils.voc._get_attributes

fiftyone.utils.voc.html#_get_attributes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.voc._parse_attribute

fiftyone.utils.voc.html#_parse_attribute

Function

Function

PRIVATE

Undocumented
fiftyone.utils.yolo.logger

fiftyone.utils.yolo.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.add_yolo_labels

fiftyone.utils.yolo.html#add_yolo_labels

Function

Function

PUBLIC

Adds the given YOLO-formatted labels to the collection.
fiftyone.utils.yolo.YOLOv4DatasetImporter

fiftyone.utils.yolo.YOLOv4DatasetImporter.html

Class

Class

PUBLIC

Importer for YOLOv4 datasets stored on disk.
fiftyone.utils.yolo.YOLOv4DatasetImporter.data_path

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetImporter.labels_path

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetImporter.images_path

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#images_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetImporter.objects_path

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#objects_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetImporter.classes

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetImporter.label_type

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#label_type

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetImporter.include_all_data

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#include_all_data

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetImporter.__init__

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetImporter._info

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetImporter._classes

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetImporter._labels_paths_map

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#_labels_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetImporter._filepaths

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#_filepaths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetImporter._iter_filepaths

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#_iter_filepaths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetImporter._num_samples

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetImporter.__iter__

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetImporter.__len__

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.yolo.YOLOv4DatasetImporter.__next__

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.yolo.YOLOv4DatasetImporter.has_dataset_info

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.yolo.YOLOv4DatasetImporter.has_image_metadata

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.yolo.YOLOv4DatasetImporter.label_cls

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.yolo.YOLOv4DatasetImporter.setup

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.yolo.YOLOv4DatasetImporter.get_dataset_info

fiftyone.utils.yolo.YOLOv4DatasetImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.yolo.YOLOv5DatasetImporter

fiftyone.utils.yolo.YOLOv5DatasetImporter.html

Class

Class

PUBLIC

Importer for YOLOv5 datasets stored on disk.
fiftyone.utils.yolo.YOLOv5DatasetImporter.yaml_path

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#yaml_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetImporter.split

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#split

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetImporter.label_type

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#label_type

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetImporter.include_all_data

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#include_all_data

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetImporter.__init__

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetImporter._info

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#_info

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetImporter._classes

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetImporter._labels_paths_map

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#_labels_paths_map

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetImporter._filepaths

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#_filepaths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetImporter._iter_filepaths

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#_iter_filepaths

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetImporter._num_samples

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#_num_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetImporter.__iter__

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#__iter__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetImporter.__len__

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#__len__

Function

Method

PUBLIC

The total number of samples that will be imported.
fiftyone.utils.yolo.YOLOv5DatasetImporter.__next__

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#__next__

Function

Method

PUBLIC

Returns information about the next sample in the dataset.
fiftyone.utils.yolo.YOLOv5DatasetImporter.has_dataset_info

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#has_dataset_info

Attribute

Property

PUBLIC

Whether this importer produces a dataset info dictionary.
fiftyone.utils.yolo.YOLOv5DatasetImporter.has_image_metadata

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#has_image_metadata

Attribute

Property

PUBLIC

Whether this importer produces fiftyone.core.metadata.ImageMetadata instances for each image.
fiftyone.utils.yolo.YOLOv5DatasetImporter.label_cls

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) returned by this importer.
fiftyone.utils.yolo.YOLOv5DatasetImporter.setup

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before importing the first sample in the dataset.
fiftyone.utils.yolo.YOLOv5DatasetImporter.get_dataset_info

fiftyone.utils.yolo.YOLOv5DatasetImporter.html#get_dataset_info

Function

Method

PUBLIC

Returns the dataset info for the dataset.
fiftyone.utils.yolo.YOLOv4DatasetExporter

fiftyone.utils.yolo.YOLOv4DatasetExporter.html

Class

Class

PUBLIC

Exporter that writes YOLOv4 datasets to disk.
fiftyone.utils.yolo.YOLOv4DatasetExporter.data_path

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter.labels_path

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter.objects_path

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#objects_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter.images_path

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#images_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter.export_media

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter.rel_dir

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter.classes

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter.include_confidence

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#include_confidence

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter.image_format

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter.__init__

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter._classes

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter._dynamic_classes

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#_dynamic_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter._labels_map_rev

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#_labels_map_rev

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter._rel_dir

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#_rel_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter._images

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#_images

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter._writer

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#_writer

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter._media_exporter

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv4DatasetExporter.requires_image_metadata

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#requires_image_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.
fiftyone.utils.yolo.YOLOv4DatasetExporter.label_cls

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) exported by this exporter.
fiftyone.utils.yolo.YOLOv4DatasetExporter.setup

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.yolo.YOLOv4DatasetExporter.export_sample

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.yolo.YOLOv4DatasetExporter.close

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.yolo.YOLOv4DatasetExporter._parse_classes

fiftyone.utils.yolo.YOLOv4DatasetExporter.html#_parse_classes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter

fiftyone.utils.yolo.YOLOv5DatasetExporter.html

Class

Class

PUBLIC

Exporter that writes YOLOv5 datasets to disk.
fiftyone.utils.yolo.YOLOv5DatasetExporter.split

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#split

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter.data_path

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#data_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter.labels_path

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#labels_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter.yaml_path

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#yaml_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter.export_media

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#export_media

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter.rel_dir

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#rel_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter.classes

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter.include_confidence

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#include_confidence

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter.image_format

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#image_format

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter.include_path

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#include_path

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter.__init__

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter._classes

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter._dynamic_classes

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#_dynamic_classes

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter._labels_map_rev

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#_labels_map_rev

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter._rel_dir

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#_rel_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter._images

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#_images

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter._writer

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#_writer

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter._media_exporter

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#_media_exporter

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOv5DatasetExporter.requires_image_metadata

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#requires_image_metadata

Attribute

Property

PUBLIC

Whether this exporter requires fiftyone.core.metadata.ImageMetadata instances for each sample being exported.
fiftyone.utils.yolo.YOLOv5DatasetExporter.label_cls

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#label_cls

Attribute

Property

PUBLIC

The fiftyone.core.labels.Label class(es) exported by this exporter.
fiftyone.utils.yolo.YOLOv5DatasetExporter.setup

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#setup

Function

Method

PUBLIC

Performs any necessary setup before exporting the first sample in the dataset.
fiftyone.utils.yolo.YOLOv5DatasetExporter.export_sample

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#export_sample

Function

Method

PUBLIC

Exports the given sample to the dataset.
fiftyone.utils.yolo.YOLOv5DatasetExporter.close

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#close

Function

Method

PUBLIC

Performs any necessary actions after the last sample has been exported.
fiftyone.utils.yolo.YOLOv5DatasetExporter._parse_classes

fiftyone.utils.yolo.YOLOv5DatasetExporter.html#_parse_classes

Function

Method

PRIVATE

Undocumented
fiftyone.utils.yolo.YOLOAnnotationWriter

fiftyone.utils.yolo.YOLOAnnotationWriter.html

Class

Class

PUBLIC

Class for writing annotations in YOLO-style TXT format.
fiftyone.utils.yolo.YOLOAnnotationWriter.write

fiftyone.utils.yolo.YOLOAnnotationWriter.html#write

Function

Method

PUBLIC

Writes the labels to disk.
fiftyone.utils.yolo.load_yolo_annotations

fiftyone.utils.yolo.html#load_yolo_annotations

Function

Function

PUBLIC

Loads the YOLO-style annotations from the given TXT file.
fiftyone.utils.yolo._parse_yolo_v5_path

fiftyone.utils.yolo.html#_parse_yolo_v5_path

Function

Function

PRIVATE

Undocumented
fiftyone.utils.yolo._make_yolo_v5_path

fiftyone.utils.yolo.html#_make_yolo_v5_path

Function

Function

PRIVATE

Undocumented
fiftyone.utils.yolo._get_yolo_v5_labels_path

fiftyone.utils.yolo.html#_get_yolo_v5_labels_path

Function

Function

PRIVATE

Undocumented
fiftyone.utils.yolo._parse_yolo_row

fiftyone.utils.yolo.html#_parse_yolo_row

Function

Function

PRIVATE

Undocumented
fiftyone.utils.yolo._make_yolo_row

fiftyone.utils.yolo.html#_make_yolo_row

Function

Function

PRIVATE

Undocumented
fiftyone.utils.yolo._parse_yolo_classes

fiftyone.utils.yolo.html#_parse_yolo_classes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.yolo._read_yaml_file

fiftyone.utils.yolo.html#_read_yaml_file

Function

Function

PRIVATE

Undocumented
fiftyone.utils.yolo._write_yaml_file

fiftyone.utils.yolo.html#_write_yaml_file

Function

Function

PRIVATE

Undocumented
fiftyone.utils.yolo._read_file_lines

fiftyone.utils.yolo.html#_read_file_lines

Function

Function

PRIVATE

Undocumented
fiftyone.utils.yolo._write_file_lines

fiftyone.utils.yolo.html#_write_file_lines

Function

Function

PRIVATE

Undocumented
fiftyone.utils.yolo._to_labels_map_rev

fiftyone.utils.yolo.html#_to_labels_map_rev

Function

Function

PRIVATE

Undocumented
fiftyone.utils.yolo._to_classes

fiftyone.utils.yolo.html#_to_classes

Function

Function

PRIVATE

Undocumented
fiftyone.utils.youtube._ensure_pytube

fiftyone.utils.youtube.html#_ensure_pytube

Function

Function

PRIVATE

Undocumented
fiftyone.utils.youtube.pytube

fiftyone.utils.youtube.html#pytube

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.youtube.logger

fiftyone.utils.youtube.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.utils.youtube.download_youtube_videos

fiftyone.utils.youtube.html#download_youtube_videos

Function

Function

PUBLIC

Downloads a list of YouTube videos.
fiftyone.utils.youtube._parse_num_workers

fiftyone.utils.youtube.html#_parse_num_workers

Function

Function

PRIVATE

Undocumented
fiftyone.utils.youtube._build_tasks_list

fiftyone.utils.youtube.html#_build_tasks_list

Function

Function

PRIVATE

Undocumented
fiftyone.utils.youtube._download

fiftyone.utils.youtube.html#_download

Function

Function

PRIVATE

Undocumented
fiftyone.utils.youtube._download_multi

fiftyone.utils.youtube.html#_download_multi

Function

Function

PRIVATE

Undocumented
fiftyone.utils.youtube._do_download

fiftyone.utils.youtube.html#_do_download

Function

Function

PRIVATE

Undocumented
fiftyone.utils.youtube._validate_video

fiftyone.utils.youtube.html#_validate_video

Function

Function

PRIVATE

Undocumented
fiftyone.utils.youtube._get_stream

fiftyone.utils.youtube.html#_get_stream

Function

Function

PRIVATE

Undocumented
fiftyone.utils.youtube._find_nearest

fiftyone.utils.youtube.html#_find_nearest

Function

Function

PRIVATE

Undocumented
fiftyone.utils.youtube._download_video

fiftyone.utils.youtube.html#_download_video

Function

Function

PRIVATE

Undocumented
fiftyone.utils.youtube._download_clip

fiftyone.utils.youtube.html#_download_clip

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets.DATASET_METADATA_FILENAMES

fiftyone.zoo.datasets.html#DATASET_METADATA_FILENAMES

Attribute

Constant

PUBLIC

Undocumented
fiftyone.zoo.datasets.logger

fiftyone.zoo.datasets.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.list_zoo_datasets

fiftyone.zoo.datasets.html#list_zoo_datasets

Function

Function

PUBLIC

Lists the available datasets in the FiftyOne Dataset Zoo.
fiftyone.zoo.datasets._list_zoo_datasets

fiftyone.zoo.datasets.html#_list_zoo_datasets

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets.list_zoo_dataset_sources

fiftyone.zoo.datasets.html#list_zoo_dataset_sources

Function

Function

PUBLIC

Returns the list of available zoo dataset sources.
fiftyone.zoo.datasets.list_downloaded_zoo_datasets

fiftyone.zoo.datasets.html#list_downloaded_zoo_datasets

Function

Function

PUBLIC

Returns information about the zoo datasets that have been downloaded.
fiftyone.zoo.datasets.download_zoo_dataset

fiftyone.zoo.datasets.html#download_zoo_dataset

Function

Function

PUBLIC

Downloads the specified dataset from the FiftyOne Dataset Zoo.
fiftyone.zoo.datasets._overwrite_download

fiftyone.zoo.datasets.html#_overwrite_download

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets.load_zoo_dataset

fiftyone.zoo.datasets.html#load_zoo_dataset

Function

Function

PUBLIC

Loads the specified dataset from the FiftyOne Dataset Zoo.
fiftyone.zoo.datasets.find_zoo_dataset

fiftyone.zoo.datasets.html#find_zoo_dataset

Function

Function

PUBLIC

Returns the directory containing the given zoo dataset.
fiftyone.zoo.datasets.load_zoo_dataset_info

fiftyone.zoo.datasets.html#load_zoo_dataset_info

Function

Function

PUBLIC

Loads the ZooDatasetInfo for the specified zoo dataset.
fiftyone.zoo.datasets.get_zoo_dataset

fiftyone.zoo.datasets.html#get_zoo_dataset

Function

Function

PUBLIC

Returns the ZooDataset instance for the given dataset.
fiftyone.zoo.datasets.delete_zoo_dataset

fiftyone.zoo.datasets.html#delete_zoo_dataset

Function

Function

PUBLIC

Deletes the zoo dataset from local disk, if necessary.
fiftyone.zoo.datasets._parse_splits

fiftyone.zoo.datasets.html#_parse_splits

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets._get_zoo_datasets

fiftyone.zoo.datasets.html#_get_zoo_datasets

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets._init_zoo_datasets

fiftyone.zoo.datasets.html#_init_zoo_datasets

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets._load_zoo_dataset_manifest

fiftyone.zoo.datasets.html#_load_zoo_dataset_manifest

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets._get_zoo_dataset_sources

fiftyone.zoo.datasets.html#_get_zoo_dataset_sources

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets._parse_dataset_details

fiftyone.zoo.datasets.html#_parse_dataset_details

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets._parse_dataset_identifier

fiftyone.zoo.datasets.html#_parse_dataset_identifier

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets._get_zoo_dataset_dir

fiftyone.zoo.datasets.html#_get_zoo_dataset_dir

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets.ZooDatasetInfo

fiftyone.zoo.datasets.ZooDatasetInfo.html

Class

Class

PUBLIC

Class containing info about a dataset in the FiftyOne Dataset Zoo.
fiftyone.zoo.datasets.ZooDatasetInfo.downloaded_splits

fiftyone.zoo.datasets.ZooDatasetInfo.html#downloaded_splits

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.ZooDatasetInfo.parameters

fiftyone.zoo.datasets.ZooDatasetInfo.html#parameters

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.ZooDatasetInfo.classes

fiftyone.zoo.datasets.ZooDatasetInfo.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.ZooDatasetInfo.__init__

fiftyone.zoo.datasets.ZooDatasetInfo.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.ZooDatasetInfo._zoo_dataset

fiftyone.zoo.datasets.ZooDatasetInfo.html#_zoo_dataset

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.ZooDatasetInfo._dataset_type

fiftyone.zoo.datasets.ZooDatasetInfo.html#_dataset_type

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.ZooDatasetInfo.num_samples

fiftyone.zoo.datasets.ZooDatasetInfo.html#num_samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.ZooDatasetInfo.name

fiftyone.zoo.datasets.ZooDatasetInfo.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.ZooDatasetInfo.zoo_dataset

fiftyone.zoo.datasets.ZooDatasetInfo.html#zoo_dataset

Attribute

Property

PUBLIC

The fully-qualified class string for the ZooDataset of the dataset.
fiftyone.zoo.datasets.ZooDatasetInfo.dataset_type

fiftyone.zoo.datasets.ZooDatasetInfo.html#dataset_type

Attribute

Property

PUBLIC

The fully-qualified class string of the fiftyone.types.Dataset type, if any.
fiftyone.zoo.datasets.ZooDatasetInfo.supported_splits

fiftyone.zoo.datasets.ZooDatasetInfo.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.ZooDatasetInfo.url

fiftyone.zoo.datasets.ZooDatasetInfo.html#url

Attribute

Property

PUBLIC

The dataset's URL, or None if it is not remotely-sourced.
fiftyone.zoo.datasets.ZooDatasetInfo.get_zoo_dataset

fiftyone.zoo.datasets.ZooDatasetInfo.html#get_zoo_dataset

Function

Method

PUBLIC

Returns the ZooDataset instance for the dataset.
fiftyone.zoo.datasets.ZooDatasetInfo.get_dataset_type

fiftyone.zoo.datasets.ZooDatasetInfo.html#get_dataset_type

Function

Method

PUBLIC

Returns the fiftyone.types.Dataset type instance for the dataset.
fiftyone.zoo.datasets.ZooDatasetInfo.is_split_downloaded

fiftyone.zoo.datasets.ZooDatasetInfo.html#is_split_downloaded

Function

Method

PUBLIC

Whether the given dataset split is downloaded.
fiftyone.zoo.datasets.ZooDatasetInfo.add_split

fiftyone.zoo.datasets.ZooDatasetInfo.html#add_split

Function

Method

PUBLIC

Adds the split to the dataset.
fiftyone.zoo.datasets.ZooDatasetInfo.remove_split

fiftyone.zoo.datasets.ZooDatasetInfo.html#remove_split

Function

Method

PUBLIC

Removes the split from the dataset.
fiftyone.zoo.datasets.ZooDatasetInfo.attributes

fiftyone.zoo.datasets.ZooDatasetInfo.html#attributes

Function

Method

PUBLIC

Returns a list of class attributes to be serialized.
fiftyone.zoo.datasets.ZooDatasetInfo.from_dict

fiftyone.zoo.datasets.ZooDatasetInfo.html#from_dict

Function

Class Method

PUBLIC

Loads a ZooDatasetInfo from a JSON dictionary.
fiftyone.zoo.datasets.ZooDatasetInfo.from_json

fiftyone.zoo.datasets.ZooDatasetInfo.html#from_json

Function

Class Method

PUBLIC

Loads a ZooDatasetInfo from a JSON file on disk.
fiftyone.zoo.datasets.ZooDatasetInfo._from_dict

fiftyone.zoo.datasets.ZooDatasetInfo.html#_from_dict

Function

Class Method

PRIVATE

Undocumented
fiftyone.zoo.datasets.ZooDatasetInfo._compute_num_samples

fiftyone.zoo.datasets.ZooDatasetInfo.html#_compute_num_samples

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.datasets.ZooDatasetSplitInfo

fiftyone.zoo.datasets.ZooDatasetSplitInfo.html

Class

Class

PUBLIC

Class containing info about a split of a dataset in the FiftyOne Dataset Zoo.
fiftyone.zoo.datasets.ZooDatasetSplitInfo.__init__

fiftyone.zoo.datasets.ZooDatasetSplitInfo.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.ZooDatasetSplitInfo.split

fiftyone.zoo.datasets.ZooDatasetSplitInfo.html#split

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.ZooDatasetSplitInfo.num_samples

fiftyone.zoo.datasets.ZooDatasetSplitInfo.html#num_samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.ZooDatasetSplitInfo.attributes

fiftyone.zoo.datasets.ZooDatasetSplitInfo.html#attributes

Function

Method

PUBLIC

Returns a list of class attributes to be serialized.
fiftyone.zoo.datasets.ZooDatasetSplitInfo.from_dict

fiftyone.zoo.datasets.ZooDatasetSplitInfo.html#from_dict

Function

Class Method

PUBLIC

Loads a ZooDatasetSplitInfo from a JSON dictionary.
fiftyone.zoo.datasets.ZooDataset

fiftyone.zoo.datasets.ZooDataset.html

Class

Class

PUBLIC

Base class for datasets made available in the FiftyOne Dataset Zoo.
fiftyone.zoo.datasets.ZooDataset.name

fiftyone.zoo.datasets.ZooDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.ZooDataset.is_remote

fiftyone.zoo.datasets.ZooDataset.html#is_remote

Attribute

Property

PUBLIC

Whether the dataset is remotely-sourced.
fiftyone.zoo.datasets.ZooDataset.tags

fiftyone.zoo.datasets.ZooDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.ZooDataset.has_tags

fiftyone.zoo.datasets.ZooDataset.html#has_tags

Attribute

Property

PUBLIC

Whether the dataset has tags.
fiftyone.zoo.datasets.ZooDataset.parameters

fiftyone.zoo.datasets.ZooDataset.html#parameters

Attribute

Property

PUBLIC

An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded.
fiftyone.zoo.datasets.ZooDataset.supported_splits

fiftyone.zoo.datasets.ZooDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.ZooDataset.has_splits

fiftyone.zoo.datasets.ZooDataset.html#has_splits

Attribute

Property

PUBLIC

Whether the dataset has splits.
fiftyone.zoo.datasets.ZooDataset.has_patches

fiftyone.zoo.datasets.ZooDataset.html#has_patches

Attribute

Property

PUBLIC

Whether the dataset has patches that may need to be applied to already downloaded files.
fiftyone.zoo.datasets.ZooDataset.supports_partial_downloads

fiftyone.zoo.datasets.ZooDataset.html#supports_partial_downloads

Attribute

Property

PUBLIC

Whether the dataset supports downloading partial subsets of its splits.
fiftyone.zoo.datasets.ZooDataset.requires_manual_download

fiftyone.zoo.datasets.ZooDataset.html#requires_manual_download

Attribute

Property

PUBLIC

Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded.
fiftyone.zoo.datasets.ZooDataset.importer_kwargs

fiftyone.zoo.datasets.ZooDataset.html#importer_kwargs

Attribute

Property

PUBLIC

A dict of default kwargs to pass to this dataset's fiftyone.utils.data.importers.DatasetImporter.
fiftyone.zoo.datasets.ZooDataset.has_tag

fiftyone.zoo.datasets.ZooDataset.html#has_tag

Function

Method

PUBLIC

Whether the dataset has the given tag.
fiftyone.zoo.datasets.ZooDataset.has_split

fiftyone.zoo.datasets.ZooDataset.html#has_split

Function

Method

PUBLIC

Whether the dataset has the given split.
fiftyone.zoo.datasets.ZooDataset.get_split_dir

fiftyone.zoo.datasets.ZooDataset.html#get_split_dir

Function

Method

PUBLIC

Returns the directory for the given split of the dataset.
fiftyone.zoo.datasets.ZooDataset.has_info

fiftyone.zoo.datasets.ZooDataset.html#has_info

Function

Static Method

PUBLIC

Determines whether the directory contains ZooDatasetInfo.
fiftyone.zoo.datasets.ZooDataset.load_info

fiftyone.zoo.datasets.ZooDataset.html#load_info

Function

Static Method

PUBLIC

Loads the ZooDatasetInfo from the given dataset directory.
fiftyone.zoo.datasets.ZooDataset.get_info_path

fiftyone.zoo.datasets.ZooDataset.html#get_info_path

Function

Static Method

PUBLIC

Returns the path to the ZooDatasetInfo for the dataset.
fiftyone.zoo.datasets.ZooDataset.download_and_prepare

fiftyone.zoo.datasets.ZooDataset.html#download_and_prepare

Function

Method

PUBLIC

Downloads the dataset and prepares it for use.
fiftyone.zoo.datasets.ZooDataset._download_and_prepare

fiftyone.zoo.datasets.ZooDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.ZooDataset._patch_if_necessary

fiftyone.zoo.datasets.ZooDataset.html#_patch_if_necessary

Function

Method

PRIVATE

Internal method called when an already downloaded dataset may need to be patched.
fiftyone.zoo.datasets.ZooDataset._get_splits_to_download

fiftyone.zoo.datasets.ZooDataset.html#_get_splits_to_download

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.datasets.ZooDataset._is_split_ready

fiftyone.zoo.datasets.ZooDataset.html#_is_split_ready

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.datasets.ZooDataset._is_dataset_ready

fiftyone.zoo.datasets.ZooDataset.html#_is_dataset_ready

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset

fiftyone.zoo.datasets.RemoteZooDataset.html

Class

Class

PUBLIC

Class for working with remotely-sourced datasets that are compatible with the FiftyOne Dataset Zoo.
fiftyone.zoo.datasets.RemoteZooDataset.__init__

fiftyone.zoo.datasets.RemoteZooDataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._dataset_dir

fiftyone.zoo.datasets.RemoteZooDataset.html#_dataset_dir

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._metadata

fiftyone.zoo.datasets.RemoteZooDataset.html#_metadata

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._url

fiftyone.zoo.datasets.RemoteZooDataset.html#_url

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._kwargs

fiftyone.zoo.datasets.RemoteZooDataset.html#_kwargs

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._name

fiftyone.zoo.datasets.RemoteZooDataset.html#_name

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._author

fiftyone.zoo.datasets.RemoteZooDataset.html#_author

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._version

fiftyone.zoo.datasets.RemoteZooDataset.html#_version

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._source

fiftyone.zoo.datasets.RemoteZooDataset.html#_source

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._license

fiftyone.zoo.datasets.RemoteZooDataset.html#_license

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._description

fiftyone.zoo.datasets.RemoteZooDataset.html#_description

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._fiftyone_version

fiftyone.zoo.datasets.RemoteZooDataset.html#_fiftyone_version

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._supports_partial_downloads

fiftyone.zoo.datasets.RemoteZooDataset.html#_supports_partial_downloads

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._tags

fiftyone.zoo.datasets.RemoteZooDataset.html#_tags

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._splits

fiftyone.zoo.datasets.RemoteZooDataset.html#_splits

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._size_samples

fiftyone.zoo.datasets.RemoteZooDataset.html#_size_samples

Attribute

Instance Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._parse_tuple

fiftyone.zoo.datasets.RemoteZooDataset.html#_parse_tuple

Function

Static Method

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset.metadata

fiftyone.zoo.datasets.RemoteZooDataset.html#metadata

Attribute

Property

PUBLIC

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset.name

fiftyone.zoo.datasets.RemoteZooDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.RemoteZooDataset.url

fiftyone.zoo.datasets.RemoteZooDataset.html#url

Attribute

Property

PUBLIC

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset.is_remote

fiftyone.zoo.datasets.RemoteZooDataset.html#is_remote

Attribute

Property

PUBLIC

Whether the dataset is remotely-sourced.
fiftyone.zoo.datasets.RemoteZooDataset.author

fiftyone.zoo.datasets.RemoteZooDataset.html#author

Attribute

Property

PUBLIC

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset.version

fiftyone.zoo.datasets.RemoteZooDataset.html#version

Attribute

Property

PUBLIC

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset.source

fiftyone.zoo.datasets.RemoteZooDataset.html#source

Attribute

Property

PUBLIC

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset.license

fiftyone.zoo.datasets.RemoteZooDataset.html#license

Attribute

Property

PUBLIC

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset.description

fiftyone.zoo.datasets.RemoteZooDataset.html#description

Attribute

Property

PUBLIC

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset.fiftyone_version

fiftyone.zoo.datasets.RemoteZooDataset.html#fiftyone_version

Attribute

Property

PUBLIC

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset.tags

fiftyone.zoo.datasets.RemoteZooDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.RemoteZooDataset.supported_splits

fiftyone.zoo.datasets.RemoteZooDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.RemoteZooDataset.supports_partial_downloads

fiftyone.zoo.datasets.RemoteZooDataset.html#supports_partial_downloads

Attribute

Property

PUBLIC

Whether the dataset supports downloading partial subsets of its splits.
fiftyone.zoo.datasets.RemoteZooDataset.size_samples

fiftyone.zoo.datasets.RemoteZooDataset.html#size_samples

Attribute

Property

PUBLIC

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._download_and_prepare

fiftyone.zoo.datasets.RemoteZooDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.RemoteZooDataset._load_dataset

fiftyone.zoo.datasets.RemoteZooDataset.html#_load_dataset

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.datasets.RemoteZooDataset._import_module

fiftyone.zoo.datasets.RemoteZooDataset.html#_import_module

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.datasets._normalize_ref

fiftyone.zoo.datasets.html#_normalize_ref

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets._load_dataset_metadata

fiftyone.zoo.datasets.html#_load_dataset_metadata

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets._download_dataset_metadata

fiftyone.zoo.datasets.html#_download_dataset_metadata

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets._find_dataset_metadata

fiftyone.zoo.datasets.html#_find_dataset_metadata

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets._download_archive

fiftyone.zoo.datasets.html#_download_archive

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets.DeprecatedZooDataset

fiftyone.zoo.datasets.DeprecatedZooDataset.html

Class

Class

PUBLIC

Class representing a zoo dataset that no longer exists in the FiftyOne Dataset Zoo.
fiftyone.zoo.datasets.DeprecatedZooDataset.name

fiftyone.zoo.datasets.DeprecatedZooDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.DeprecatedZooDataset.supported_splits

fiftyone.zoo.datasets.DeprecatedZooDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.DeprecatedZooDataset._download_and_prepare

fiftyone.zoo.datasets.DeprecatedZooDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets._migrate_zoo_dataset_info

fiftyone.zoo.datasets.html#_migrate_zoo_dataset_info

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.logger

fiftyone.zoo.datasets.base.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.FiftyOneDataset

fiftyone.zoo.datasets.base.FiftyOneDataset.html

Class

Class

PUBLIC

Base class for zoo datasets that are provided natively by FiftyOne.
fiftyone.zoo.datasets.base.ActivityNet100Dataset

fiftyone.zoo.datasets.base.ActivityNet100Dataset.html

Class

Class

PUBLIC

ActivityNet is a large-scale video dataset for human activity understanding supporting the tasks of global video classification, trimmed activity classification, and temporal activity detection.
fiftyone.zoo.datasets.base.ActivityNet100Dataset.source_dir

fiftyone.zoo.datasets.base.ActivityNet100Dataset.html#source_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet100Dataset.classes

fiftyone.zoo.datasets.base.ActivityNet100Dataset.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet100Dataset.max_duration

fiftyone.zoo.datasets.base.ActivityNet100Dataset.html#max_duration

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet100Dataset.copy_files

fiftyone.zoo.datasets.base.ActivityNet100Dataset.html#copy_files

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet100Dataset.num_workers

fiftyone.zoo.datasets.base.ActivityNet100Dataset.html#num_workers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet100Dataset.shuffle

fiftyone.zoo.datasets.base.ActivityNet100Dataset.html#shuffle

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet100Dataset.seed

fiftyone.zoo.datasets.base.ActivityNet100Dataset.html#seed

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet100Dataset.max_samples

fiftyone.zoo.datasets.base.ActivityNet100Dataset.html#max_samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet100Dataset.__init__

fiftyone.zoo.datasets.base.ActivityNet100Dataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet100Dataset.name

fiftyone.zoo.datasets.base.ActivityNet100Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.ActivityNet100Dataset.tags

fiftyone.zoo.datasets.base.ActivityNet100Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.ActivityNet100Dataset.supported_splits

fiftyone.zoo.datasets.base.ActivityNet100Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.ActivityNet100Dataset.supports_partial_downloads

fiftyone.zoo.datasets.base.ActivityNet100Dataset.html#supports_partial_downloads

Attribute

Property

PUBLIC

Whether the dataset supports downloading partial subsets of its splits.
fiftyone.zoo.datasets.base.ActivityNet100Dataset._download_and_prepare

fiftyone.zoo.datasets.base.ActivityNet100Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.ActivityNet200Dataset

fiftyone.zoo.datasets.base.ActivityNet200Dataset.html

Class

Class

PUBLIC

ActivityNet is a large-scale video dataset for human activity understanding supporting the tasks of global video classification, trimmed activity classification, and temporal activity detection.
fiftyone.zoo.datasets.base.ActivityNet200Dataset.source_dir

fiftyone.zoo.datasets.base.ActivityNet200Dataset.html#source_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet200Dataset.classes

fiftyone.zoo.datasets.base.ActivityNet200Dataset.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet200Dataset.max_duration

fiftyone.zoo.datasets.base.ActivityNet200Dataset.html#max_duration

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet200Dataset.copy_files

fiftyone.zoo.datasets.base.ActivityNet200Dataset.html#copy_files

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet200Dataset.num_workers

fiftyone.zoo.datasets.base.ActivityNet200Dataset.html#num_workers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet200Dataset.shuffle

fiftyone.zoo.datasets.base.ActivityNet200Dataset.html#shuffle

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet200Dataset.seed

fiftyone.zoo.datasets.base.ActivityNet200Dataset.html#seed

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet200Dataset.max_samples

fiftyone.zoo.datasets.base.ActivityNet200Dataset.html#max_samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet200Dataset.__init__

fiftyone.zoo.datasets.base.ActivityNet200Dataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.ActivityNet200Dataset.name

fiftyone.zoo.datasets.base.ActivityNet200Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.ActivityNet200Dataset.tags

fiftyone.zoo.datasets.base.ActivityNet200Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.ActivityNet200Dataset.supported_splits

fiftyone.zoo.datasets.base.ActivityNet200Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.ActivityNet200Dataset.supports_partial_downloads

fiftyone.zoo.datasets.base.ActivityNet200Dataset.html#supports_partial_downloads

Attribute

Property

PUBLIC

Whether the dataset supports downloading partial subsets of its splits.
fiftyone.zoo.datasets.base.ActivityNet200Dataset._download_and_prepare

fiftyone.zoo.datasets.base.ActivityNet200Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.BDD100KDataset

fiftyone.zoo.datasets.base.BDD100KDataset.html

Class

Class

PUBLIC

The Berkeley Deep Drive (BDD) dataset is one of the largest and most diverse video datasets for autonomous vehicles.
fiftyone.zoo.datasets.base.BDD100KDataset.source_dir

fiftyone.zoo.datasets.base.BDD100KDataset.html#source_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.BDD100KDataset.copy_files

fiftyone.zoo.datasets.base.BDD100KDataset.html#copy_files

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.BDD100KDataset.__init__

fiftyone.zoo.datasets.base.BDD100KDataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.BDD100KDataset.name

fiftyone.zoo.datasets.base.BDD100KDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.BDD100KDataset.tags

fiftyone.zoo.datasets.base.BDD100KDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.BDD100KDataset.supported_splits

fiftyone.zoo.datasets.base.BDD100KDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.BDD100KDataset.requires_manual_download

fiftyone.zoo.datasets.base.BDD100KDataset.html#requires_manual_download

Attribute

Property

PUBLIC

Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded.
fiftyone.zoo.datasets.base.BDD100KDataset._download_and_prepare

fiftyone.zoo.datasets.base.BDD100KDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.Caltech101Dataset

fiftyone.zoo.datasets.base.Caltech101Dataset.html

Class

Class

PUBLIC

The Caltech-101 dataset of images.
fiftyone.zoo.datasets.base.Caltech101Dataset._GDRIVE_ID

fiftyone.zoo.datasets.base.Caltech101Dataset.html#_GDRIVE_ID

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.Caltech101Dataset._ARCHIVE_NAME

fiftyone.zoo.datasets.base.Caltech101Dataset.html#_ARCHIVE_NAME

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.Caltech101Dataset._DIR_IN_ARCHIVE

fiftyone.zoo.datasets.base.Caltech101Dataset.html#_DIR_IN_ARCHIVE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.Caltech101Dataset.name

fiftyone.zoo.datasets.base.Caltech101Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.Caltech101Dataset.tags

fiftyone.zoo.datasets.base.Caltech101Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.Caltech101Dataset.supported_splits

fiftyone.zoo.datasets.base.Caltech101Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.Caltech101Dataset._download_and_prepare

fiftyone.zoo.datasets.base.Caltech101Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.Caltech256Dataset

fiftyone.zoo.datasets.base.Caltech256Dataset.html

Class

Class

PUBLIC

The Caltech-256 dataset of images.
fiftyone.zoo.datasets.base.Caltech256Dataset._GDRIVE_ID

fiftyone.zoo.datasets.base.Caltech256Dataset.html#_GDRIVE_ID

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.Caltech256Dataset._ARCHIVE_NAME

fiftyone.zoo.datasets.base.Caltech256Dataset.html#_ARCHIVE_NAME

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.Caltech256Dataset._DIR_IN_ARCHIVE

fiftyone.zoo.datasets.base.Caltech256Dataset.html#_DIR_IN_ARCHIVE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.Caltech256Dataset.name

fiftyone.zoo.datasets.base.Caltech256Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.Caltech256Dataset.tags

fiftyone.zoo.datasets.base.Caltech256Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.Caltech256Dataset.supported_splits

fiftyone.zoo.datasets.base.Caltech256Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.Caltech256Dataset._download_and_prepare

fiftyone.zoo.datasets.base.Caltech256Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.CityscapesDataset

fiftyone.zoo.datasets.base.CityscapesDataset.html

Class

Class

PUBLIC

Cityscapes is a large-scale dataset that contains a diverse set of stereo video sequences recorded in street scenes from 50 different cities, with high quality pixel-level annotations of 5,000 frames in addition to a larger set of 20,000 weakly annotated frames.
fiftyone.zoo.datasets.base.CityscapesDataset.source_dir

fiftyone.zoo.datasets.base.CityscapesDataset.html#source_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.CityscapesDataset.fine_annos

fiftyone.zoo.datasets.base.CityscapesDataset.html#fine_annos

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.CityscapesDataset.coarse_annos

fiftyone.zoo.datasets.base.CityscapesDataset.html#coarse_annos

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.CityscapesDataset.person_annos

fiftyone.zoo.datasets.base.CityscapesDataset.html#person_annos

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.CityscapesDataset.__init__

fiftyone.zoo.datasets.base.CityscapesDataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.CityscapesDataset.name

fiftyone.zoo.datasets.base.CityscapesDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.CityscapesDataset.tags

fiftyone.zoo.datasets.base.CityscapesDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.CityscapesDataset.supported_splits

fiftyone.zoo.datasets.base.CityscapesDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.CityscapesDataset.requires_manual_download

fiftyone.zoo.datasets.base.CityscapesDataset.html#requires_manual_download

Attribute

Property

PUBLIC

Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded.
fiftyone.zoo.datasets.base.CityscapesDataset._download_and_prepare

fiftyone.zoo.datasets.base.CityscapesDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.COCO2014Dataset

fiftyone.zoo.datasets.base.COCO2014Dataset.html

Class

Class

PUBLIC

COCO is a large-scale object detection, segmentation, and captioning dataset.
fiftyone.zoo.datasets.base.COCO2014Dataset.label_types

fiftyone.zoo.datasets.base.COCO2014Dataset.html#label_types

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.COCO2014Dataset.classes

fiftyone.zoo.datasets.base.COCO2014Dataset.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.COCO2014Dataset.image_ids

fiftyone.zoo.datasets.base.COCO2014Dataset.html#image_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.COCO2014Dataset.num_workers

fiftyone.zoo.datasets.base.COCO2014Dataset.html#num_workers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.COCO2014Dataset.shuffle

fiftyone.zoo.datasets.base.COCO2014Dataset.html#shuffle

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.COCO2014Dataset.seed

fiftyone.zoo.datasets.base.COCO2014Dataset.html#seed

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.COCO2014Dataset.max_samples

fiftyone.zoo.datasets.base.COCO2014Dataset.html#max_samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.COCO2014Dataset.__init__

fiftyone.zoo.datasets.base.COCO2014Dataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.COCO2014Dataset.name

fiftyone.zoo.datasets.base.COCO2014Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.COCO2014Dataset.tags

fiftyone.zoo.datasets.base.COCO2014Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.COCO2014Dataset.supported_splits

fiftyone.zoo.datasets.base.COCO2014Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.COCO2014Dataset.supports_partial_downloads

fiftyone.zoo.datasets.base.COCO2014Dataset.html#supports_partial_downloads

Attribute

Property

PUBLIC

Whether the dataset supports downloading partial subsets of its splits.
fiftyone.zoo.datasets.base.COCO2014Dataset.importer_kwargs

fiftyone.zoo.datasets.base.COCO2014Dataset.html#importer_kwargs

Attribute

Property

PUBLIC

A dict of default kwargs to pass to this dataset's fiftyone.utils.data.importers.DatasetImporter.
fiftyone.zoo.datasets.base.COCO2014Dataset._download_and_prepare

fiftyone.zoo.datasets.base.COCO2014Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.COCO2014Dataset._get_raw_dir

fiftyone.zoo.datasets.base.COCO2014Dataset.html#_get_raw_dir

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.COCO2017Dataset

fiftyone.zoo.datasets.base.COCO2017Dataset.html

Class

Class

PUBLIC

COCO is a large-scale object detection, segmentation, and captioning dataset.
fiftyone.zoo.datasets.base.COCO2017Dataset.label_types

fiftyone.zoo.datasets.base.COCO2017Dataset.html#label_types

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.COCO2017Dataset.classes

fiftyone.zoo.datasets.base.COCO2017Dataset.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.COCO2017Dataset.image_ids

fiftyone.zoo.datasets.base.COCO2017Dataset.html#image_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.COCO2017Dataset.num_workers

fiftyone.zoo.datasets.base.COCO2017Dataset.html#num_workers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.COCO2017Dataset.shuffle

fiftyone.zoo.datasets.base.COCO2017Dataset.html#shuffle

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.COCO2017Dataset.seed

fiftyone.zoo.datasets.base.COCO2017Dataset.html#seed

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.COCO2017Dataset.max_samples

fiftyone.zoo.datasets.base.COCO2017Dataset.html#max_samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.COCO2017Dataset.__init__

fiftyone.zoo.datasets.base.COCO2017Dataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.COCO2017Dataset.name

fiftyone.zoo.datasets.base.COCO2017Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.COCO2017Dataset.tags

fiftyone.zoo.datasets.base.COCO2017Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.COCO2017Dataset.supported_splits

fiftyone.zoo.datasets.base.COCO2017Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.COCO2017Dataset.supports_partial_downloads

fiftyone.zoo.datasets.base.COCO2017Dataset.html#supports_partial_downloads

Attribute

Property

PUBLIC

Whether the dataset supports downloading partial subsets of its splits.
fiftyone.zoo.datasets.base.COCO2017Dataset.importer_kwargs

fiftyone.zoo.datasets.base.COCO2017Dataset.html#importer_kwargs

Attribute

Property

PUBLIC

A dict of default kwargs to pass to this dataset's fiftyone.utils.data.importers.DatasetImporter.
fiftyone.zoo.datasets.base.COCO2017Dataset._download_and_prepare

fiftyone.zoo.datasets.base.COCO2017Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.COCO2017Dataset._get_raw_dir

fiftyone.zoo.datasets.base.COCO2017Dataset.html#_get_raw_dir

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.SamaCOCODataset

fiftyone.zoo.datasets.base.SamaCOCODataset.html

Class

Class

PUBLIC

Sama-COCO is a large-scale object detection, segmentation, and captioning dataset based on COCO2017. It is a relabeling of the original training and validation sets with tighter polygons and more individually annotated crowds.
fiftyone.zoo.datasets.base.SamaCOCODataset.label_types

fiftyone.zoo.datasets.base.SamaCOCODataset.html#label_types

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.SamaCOCODataset.classes

fiftyone.zoo.datasets.base.SamaCOCODataset.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.SamaCOCODataset.image_ids

fiftyone.zoo.datasets.base.SamaCOCODataset.html#image_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.SamaCOCODataset.num_workers

fiftyone.zoo.datasets.base.SamaCOCODataset.html#num_workers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.SamaCOCODataset.shuffle

fiftyone.zoo.datasets.base.SamaCOCODataset.html#shuffle

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.SamaCOCODataset.seed

fiftyone.zoo.datasets.base.SamaCOCODataset.html#seed

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.SamaCOCODataset.max_samples

fiftyone.zoo.datasets.base.SamaCOCODataset.html#max_samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.SamaCOCODataset.__init__

fiftyone.zoo.datasets.base.SamaCOCODataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.SamaCOCODataset.name

fiftyone.zoo.datasets.base.SamaCOCODataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.SamaCOCODataset.tags

fiftyone.zoo.datasets.base.SamaCOCODataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.SamaCOCODataset.supported_splits

fiftyone.zoo.datasets.base.SamaCOCODataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.SamaCOCODataset.supports_partial_downloads

fiftyone.zoo.datasets.base.SamaCOCODataset.html#supports_partial_downloads

Attribute

Property

PUBLIC

Whether the dataset supports downloading partial subsets of its splits.
fiftyone.zoo.datasets.base.SamaCOCODataset.importer_kwargs

fiftyone.zoo.datasets.base.SamaCOCODataset.html#importer_kwargs

Attribute

Property

PUBLIC

A dict of default kwargs to pass to this dataset's fiftyone.utils.data.importers.DatasetImporter.
fiftyone.zoo.datasets.base.SamaCOCODataset._download_and_prepare

fiftyone.zoo.datasets.base.SamaCOCODataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.SamaCOCODataset._get_raw_dir

fiftyone.zoo.datasets.base.SamaCOCODataset.html#_get_raw_dir

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.FIWDataset

fiftyone.zoo.datasets.base.FIWDataset.html

Class

Class

PUBLIC

Families in the Wild is a public benchmark for recognizing families via facial images. The dataset contains over 26,642 images of 5,037 faces collected from 978 families. A unique Family ID (FID) is assigned per family, ranging from F0001-F1018 (i...
fiftyone.zoo.datasets.base.FIWDataset.name

fiftyone.zoo.datasets.base.FIWDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.FIWDataset.tags

fiftyone.zoo.datasets.base.FIWDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.FIWDataset.supported_splits

fiftyone.zoo.datasets.base.FIWDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.FIWDataset._download_and_prepare

fiftyone.zoo.datasets.base.FIWDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.HMDB51Dataset

fiftyone.zoo.datasets.base.HMDB51Dataset.html

Class

Class

PUBLIC

HMDB51 is an action recognition dataset containing a total of 6,766 clips distributed across 51 action classes.
fiftyone.zoo.datasets.base.HMDB51Dataset.fold

fiftyone.zoo.datasets.base.HMDB51Dataset.html#fold

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.HMDB51Dataset.__init__

fiftyone.zoo.datasets.base.HMDB51Dataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.HMDB51Dataset.name

fiftyone.zoo.datasets.base.HMDB51Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.HMDB51Dataset.tags

fiftyone.zoo.datasets.base.HMDB51Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.HMDB51Dataset.parameters

fiftyone.zoo.datasets.base.HMDB51Dataset.html#parameters

Attribute

Property

PUBLIC

An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded.
fiftyone.zoo.datasets.base.HMDB51Dataset.supported_splits

fiftyone.zoo.datasets.base.HMDB51Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.HMDB51Dataset._download_and_prepare

fiftyone.zoo.datasets.base.HMDB51Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.ImageNetSampleDataset

fiftyone.zoo.datasets.base.ImageNetSampleDataset.html

Class

Class

PUBLIC

A small sample of images from the ImageNet 2012 dataset.
fiftyone.zoo.datasets.base.ImageNetSampleDataset._GDRIVE_ID

fiftyone.zoo.datasets.base.ImageNetSampleDataset.html#_GDRIVE_ID

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.ImageNetSampleDataset._ARCHIVE_NAME

fiftyone.zoo.datasets.base.ImageNetSampleDataset.html#_ARCHIVE_NAME

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.ImageNetSampleDataset._DIR_IN_ARCHIVE

fiftyone.zoo.datasets.base.ImageNetSampleDataset.html#_DIR_IN_ARCHIVE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.ImageNetSampleDataset.name

fiftyone.zoo.datasets.base.ImageNetSampleDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.ImageNetSampleDataset.tags

fiftyone.zoo.datasets.base.ImageNetSampleDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.ImageNetSampleDataset.supported_splits

fiftyone.zoo.datasets.base.ImageNetSampleDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.ImageNetSampleDataset._download_and_prepare

fiftyone.zoo.datasets.base.ImageNetSampleDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.Kinetics400Dataset

fiftyone.zoo.datasets.base.Kinetics400Dataset.html

Class

Class

PUBLIC

Kinetics is a collection of large-scale, high-quality datasets of URL links of up to 650,000 video clips that cover 400/600/700 human action classes, depending on the dataset version. The videos include human-object interactions such as playing instruments, as well as human-human interactions such as shaking hands and hugging...
fiftyone.zoo.datasets.base.Kinetics400Dataset.classes

fiftyone.zoo.datasets.base.Kinetics400Dataset.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics400Dataset.num_workers

fiftyone.zoo.datasets.base.Kinetics400Dataset.html#num_workers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics400Dataset.shuffle

fiftyone.zoo.datasets.base.Kinetics400Dataset.html#shuffle

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics400Dataset.seed

fiftyone.zoo.datasets.base.Kinetics400Dataset.html#seed

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics400Dataset.max_samples

fiftyone.zoo.datasets.base.Kinetics400Dataset.html#max_samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics400Dataset.__init__

fiftyone.zoo.datasets.base.Kinetics400Dataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics400Dataset.name

fiftyone.zoo.datasets.base.Kinetics400Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.Kinetics400Dataset.tags

fiftyone.zoo.datasets.base.Kinetics400Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.Kinetics400Dataset.supported_splits

fiftyone.zoo.datasets.base.Kinetics400Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.Kinetics400Dataset.supports_partial_downloads

fiftyone.zoo.datasets.base.Kinetics400Dataset.html#supports_partial_downloads

Attribute

Property

PUBLIC

Whether the dataset supports downloading partial subsets of its splits.
fiftyone.zoo.datasets.base.Kinetics400Dataset._download_and_prepare

fiftyone.zoo.datasets.base.Kinetics400Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.Kinetics600Dataset

fiftyone.zoo.datasets.base.Kinetics600Dataset.html

Class

Class

PUBLIC

Kinetics is a collection of large-scale, high-quality datasets of URL links of up to 650,000 video clips that cover 400/600/700 human action classes, depending on the dataset version. The videos include human-object interactions such as playing instruments, as well as human-human interactions such as shaking hands and hugging...
fiftyone.zoo.datasets.base.Kinetics600Dataset.classes

fiftyone.zoo.datasets.base.Kinetics600Dataset.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics600Dataset.num_workers

fiftyone.zoo.datasets.base.Kinetics600Dataset.html#num_workers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics600Dataset.shuffle

fiftyone.zoo.datasets.base.Kinetics600Dataset.html#shuffle

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics600Dataset.seed

fiftyone.zoo.datasets.base.Kinetics600Dataset.html#seed

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics600Dataset.max_samples

fiftyone.zoo.datasets.base.Kinetics600Dataset.html#max_samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics600Dataset.__init__

fiftyone.zoo.datasets.base.Kinetics600Dataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics600Dataset.name

fiftyone.zoo.datasets.base.Kinetics600Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.Kinetics600Dataset.tags

fiftyone.zoo.datasets.base.Kinetics600Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.Kinetics600Dataset.supported_splits

fiftyone.zoo.datasets.base.Kinetics600Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.Kinetics600Dataset.supports_partial_downloads

fiftyone.zoo.datasets.base.Kinetics600Dataset.html#supports_partial_downloads

Attribute

Property

PUBLIC

Whether the dataset supports downloading partial subsets of its splits.
fiftyone.zoo.datasets.base.Kinetics600Dataset._download_and_prepare

fiftyone.zoo.datasets.base.Kinetics600Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.Kinetics700Dataset

fiftyone.zoo.datasets.base.Kinetics700Dataset.html

Class

Class

PUBLIC

Kinetics is a collection of large-scale, high-quality datasets of URL links of up to 650,000 video clips that cover 400/600/700 human action classes, depending on the dataset version. The videos include human-object interactions such as playing instruments, as well as human-human interactions such as shaking hands and hugging...
fiftyone.zoo.datasets.base.Kinetics700Dataset.classes

fiftyone.zoo.datasets.base.Kinetics700Dataset.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics700Dataset.num_workers

fiftyone.zoo.datasets.base.Kinetics700Dataset.html#num_workers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics700Dataset.shuffle

fiftyone.zoo.datasets.base.Kinetics700Dataset.html#shuffle

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics700Dataset.seed

fiftyone.zoo.datasets.base.Kinetics700Dataset.html#seed

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics700Dataset.max_samples

fiftyone.zoo.datasets.base.Kinetics700Dataset.html#max_samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics700Dataset.__init__

fiftyone.zoo.datasets.base.Kinetics700Dataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics700Dataset.name

fiftyone.zoo.datasets.base.Kinetics700Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.Kinetics700Dataset.tags

fiftyone.zoo.datasets.base.Kinetics700Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.Kinetics700Dataset.supported_splits

fiftyone.zoo.datasets.base.Kinetics700Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.Kinetics700Dataset.supports_partial_downloads

fiftyone.zoo.datasets.base.Kinetics700Dataset.html#supports_partial_downloads

Attribute

Property

PUBLIC

Whether the dataset supports downloading partial subsets of its splits.
fiftyone.zoo.datasets.base.Kinetics700Dataset._download_and_prepare

fiftyone.zoo.datasets.base.Kinetics700Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.Kinetics7002020Dataset

fiftyone.zoo.datasets.base.Kinetics7002020Dataset.html

Class

Class

PUBLIC

Kinetics is a collection of large-scale, high-quality datasets of URL links of up to 650,000 video clips that cover 400/600/700 human action classes, depending on the dataset version. The videos include human-object interactions such as playing instruments, as well as human-human interactions such as shaking hands and hugging...
fiftyone.zoo.datasets.base.Kinetics7002020Dataset.classes

fiftyone.zoo.datasets.base.Kinetics7002020Dataset.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics7002020Dataset.num_workers

fiftyone.zoo.datasets.base.Kinetics7002020Dataset.html#num_workers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics7002020Dataset.shuffle

fiftyone.zoo.datasets.base.Kinetics7002020Dataset.html#shuffle

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics7002020Dataset.seed

fiftyone.zoo.datasets.base.Kinetics7002020Dataset.html#seed

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics7002020Dataset.max_samples

fiftyone.zoo.datasets.base.Kinetics7002020Dataset.html#max_samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics7002020Dataset.__init__

fiftyone.zoo.datasets.base.Kinetics7002020Dataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.Kinetics7002020Dataset.name

fiftyone.zoo.datasets.base.Kinetics7002020Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.Kinetics7002020Dataset.tags

fiftyone.zoo.datasets.base.Kinetics7002020Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.Kinetics7002020Dataset.supported_splits

fiftyone.zoo.datasets.base.Kinetics7002020Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.Kinetics7002020Dataset.supports_partial_downloads

fiftyone.zoo.datasets.base.Kinetics7002020Dataset.html#supports_partial_downloads

Attribute

Property

PUBLIC

Whether the dataset supports downloading partial subsets of its splits.
fiftyone.zoo.datasets.base.Kinetics7002020Dataset._download_and_prepare

fiftyone.zoo.datasets.base.Kinetics7002020Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.KITTIDataset

fiftyone.zoo.datasets.base.KITTIDataset.html

Class

Class

PUBLIC

KITTI contains a suite of vision tasks built using an autonomous driving platform.
fiftyone.zoo.datasets.base.KITTIDataset.name

fiftyone.zoo.datasets.base.KITTIDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.KITTIDataset.tags

fiftyone.zoo.datasets.base.KITTIDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.KITTIDataset.supported_splits

fiftyone.zoo.datasets.base.KITTIDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.KITTIDataset._download_and_prepare

fiftyone.zoo.datasets.base.KITTIDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.KITTIMultiviewDataset

fiftyone.zoo.datasets.base.KITTIMultiviewDataset.html

Class

Class

PUBLIC

KITTI contains a suite of vision tasks built using an autonomous driving platform.
fiftyone.zoo.datasets.base.KITTIMultiviewDataset.name

fiftyone.zoo.datasets.base.KITTIMultiviewDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.KITTIMultiviewDataset.tags

fiftyone.zoo.datasets.base.KITTIMultiviewDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.KITTIMultiviewDataset.supported_splits

fiftyone.zoo.datasets.base.KITTIMultiviewDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.KITTIMultiviewDataset.supports_partial_downloads

fiftyone.zoo.datasets.base.KITTIMultiviewDataset.html#supports_partial_downloads

Attribute

Property

PUBLIC

Whether the dataset supports downloading partial subsets of its splits.
fiftyone.zoo.datasets.base.KITTIMultiviewDataset.has_patches

fiftyone.zoo.datasets.base.KITTIMultiviewDataset.html#has_patches

Attribute

Property

PUBLIC

Whether the dataset has patches that may need to be applied to already downloaded files.
fiftyone.zoo.datasets.base.KITTIMultiviewDataset._download_and_prepare

fiftyone.zoo.datasets.base.KITTIMultiviewDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.KITTIMultiviewDataset._patch_if_necessary

fiftyone.zoo.datasets.base.KITTIMultiviewDataset.html#_patch_if_necessary

Function

Method

PRIVATE

Internal method called when an already downloaded dataset may need to be patched.
fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset

fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.html

Class

Class

PUBLIC

Labeled Faces in the Wild is a public benchmark for face verification, also known as pair matching.
fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.name

fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.tags

fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.supported_splits

fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset._download_and_prepare

fiftyone.zoo.datasets.base.LabeledFacesInTheWildDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.OpenImagesV6Dataset

fiftyone.zoo.datasets.base.OpenImagesV6Dataset.html

Class

Class

PUBLIC

Open Images V6 is a dataset of ~9 million images, roughly 2 million of which are annotated and available via this zoo dataset.
fiftyone.zoo.datasets.base.OpenImagesV6Dataset.label_types

fiftyone.zoo.datasets.base.OpenImagesV6Dataset.html#label_types

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV6Dataset.classes

fiftyone.zoo.datasets.base.OpenImagesV6Dataset.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV6Dataset.attrs

fiftyone.zoo.datasets.base.OpenImagesV6Dataset.html#attrs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV6Dataset.image_ids

fiftyone.zoo.datasets.base.OpenImagesV6Dataset.html#image_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV6Dataset.num_workers

fiftyone.zoo.datasets.base.OpenImagesV6Dataset.html#num_workers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV6Dataset.shuffle

fiftyone.zoo.datasets.base.OpenImagesV6Dataset.html#shuffle

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV6Dataset.seed

fiftyone.zoo.datasets.base.OpenImagesV6Dataset.html#seed

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV6Dataset.max_samples

fiftyone.zoo.datasets.base.OpenImagesV6Dataset.html#max_samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV6Dataset.__init__

fiftyone.zoo.datasets.base.OpenImagesV6Dataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV6Dataset.name

fiftyone.zoo.datasets.base.OpenImagesV6Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.OpenImagesV6Dataset.tags

fiftyone.zoo.datasets.base.OpenImagesV6Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.OpenImagesV6Dataset.supported_splits

fiftyone.zoo.datasets.base.OpenImagesV6Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.OpenImagesV6Dataset.supports_partial_downloads

fiftyone.zoo.datasets.base.OpenImagesV6Dataset.html#supports_partial_downloads

Attribute

Property

PUBLIC

Whether the dataset supports downloading partial subsets of its splits.
fiftyone.zoo.datasets.base.OpenImagesV6Dataset._download_and_prepare

fiftyone.zoo.datasets.base.OpenImagesV6Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.OpenImagesV7Dataset

fiftyone.zoo.datasets.base.OpenImagesV7Dataset.html

Class

Class

PUBLIC

Open Images V7 is a dataset of ~9 million images, roughly 2 million of which are annotated and available via this zoo dataset.
fiftyone.zoo.datasets.base.OpenImagesV7Dataset.label_types

fiftyone.zoo.datasets.base.OpenImagesV7Dataset.html#label_types

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV7Dataset.classes

fiftyone.zoo.datasets.base.OpenImagesV7Dataset.html#classes

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV7Dataset.attrs

fiftyone.zoo.datasets.base.OpenImagesV7Dataset.html#attrs

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV7Dataset.image_ids

fiftyone.zoo.datasets.base.OpenImagesV7Dataset.html#image_ids

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV7Dataset.num_workers

fiftyone.zoo.datasets.base.OpenImagesV7Dataset.html#num_workers

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV7Dataset.shuffle

fiftyone.zoo.datasets.base.OpenImagesV7Dataset.html#shuffle

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV7Dataset.seed

fiftyone.zoo.datasets.base.OpenImagesV7Dataset.html#seed

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV7Dataset.max_samples

fiftyone.zoo.datasets.base.OpenImagesV7Dataset.html#max_samples

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV7Dataset.__init__

fiftyone.zoo.datasets.base.OpenImagesV7Dataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.OpenImagesV7Dataset.name

fiftyone.zoo.datasets.base.OpenImagesV7Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.OpenImagesV7Dataset.tags

fiftyone.zoo.datasets.base.OpenImagesV7Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.OpenImagesV7Dataset.supported_splits

fiftyone.zoo.datasets.base.OpenImagesV7Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.OpenImagesV7Dataset.supports_partial_downloads

fiftyone.zoo.datasets.base.OpenImagesV7Dataset.html#supports_partial_downloads

Attribute

Property

PUBLIC

Whether the dataset supports downloading partial subsets of its splits.
fiftyone.zoo.datasets.base.OpenImagesV7Dataset._download_and_prepare

fiftyone.zoo.datasets.base.OpenImagesV7Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.PlacesDataset

fiftyone.zoo.datasets.base.PlacesDataset.html

Class

Class

PUBLIC

Places is a scene recognition dataset of 10 million images comprising ~400 unique scene categories.
fiftyone.zoo.datasets.base.PlacesDataset.name

fiftyone.zoo.datasets.base.PlacesDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.PlacesDataset.tags

fiftyone.zoo.datasets.base.PlacesDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.PlacesDataset.supported_splits

fiftyone.zoo.datasets.base.PlacesDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.PlacesDataset.supports_partial_downloads

fiftyone.zoo.datasets.base.PlacesDataset.html#supports_partial_downloads

Attribute

Property

PUBLIC

Whether the dataset supports downloading partial subsets of its splits.
fiftyone.zoo.datasets.base.PlacesDataset._download_and_prepare

fiftyone.zoo.datasets.base.PlacesDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.PlacesDataset._get_raw_dir

fiftyone.zoo.datasets.base.PlacesDataset.html#_get_raw_dir

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.QuickstartDataset

fiftyone.zoo.datasets.base.QuickstartDataset.html

Class

Class

PUBLIC

A small dataset with ground truth bounding boxes and predictions.
fiftyone.zoo.datasets.base.QuickstartDataset._GDRIVE_ID

fiftyone.zoo.datasets.base.QuickstartDataset.html#_GDRIVE_ID

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.QuickstartDataset._ARCHIVE_NAME

fiftyone.zoo.datasets.base.QuickstartDataset.html#_ARCHIVE_NAME

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.QuickstartDataset._DIR_IN_ARCHIVE

fiftyone.zoo.datasets.base.QuickstartDataset.html#_DIR_IN_ARCHIVE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.QuickstartDataset.name

fiftyone.zoo.datasets.base.QuickstartDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.QuickstartDataset.tags

fiftyone.zoo.datasets.base.QuickstartDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.QuickstartDataset.supported_splits

fiftyone.zoo.datasets.base.QuickstartDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.QuickstartDataset._download_and_prepare

fiftyone.zoo.datasets.base.QuickstartDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.QuickstartGeoDataset

fiftyone.zoo.datasets.base.QuickstartGeoDataset.html

Class

Class

PUBLIC

A small dataset with geolocation data.
fiftyone.zoo.datasets.base.QuickstartGeoDataset._GDRIVE_ID

fiftyone.zoo.datasets.base.QuickstartGeoDataset.html#_GDRIVE_ID

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.QuickstartGeoDataset._ARCHIVE_NAME

fiftyone.zoo.datasets.base.QuickstartGeoDataset.html#_ARCHIVE_NAME

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.QuickstartGeoDataset._DIR_IN_ARCHIVE

fiftyone.zoo.datasets.base.QuickstartGeoDataset.html#_DIR_IN_ARCHIVE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.QuickstartGeoDataset.name

fiftyone.zoo.datasets.base.QuickstartGeoDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.QuickstartGeoDataset.tags

fiftyone.zoo.datasets.base.QuickstartGeoDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.QuickstartGeoDataset.supported_splits

fiftyone.zoo.datasets.base.QuickstartGeoDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.QuickstartGeoDataset._download_and_prepare

fiftyone.zoo.datasets.base.QuickstartGeoDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.QuickstartVideoDataset

fiftyone.zoo.datasets.base.QuickstartVideoDataset.html

Class

Class

PUBLIC

A small video dataset with dense annotations.
fiftyone.zoo.datasets.base.QuickstartVideoDataset._GDRIVE_ID

fiftyone.zoo.datasets.base.QuickstartVideoDataset.html#_GDRIVE_ID

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.QuickstartVideoDataset._ARCHIVE_NAME

fiftyone.zoo.datasets.base.QuickstartVideoDataset.html#_ARCHIVE_NAME

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.QuickstartVideoDataset._DIR_IN_ARCHIVE

fiftyone.zoo.datasets.base.QuickstartVideoDataset.html#_DIR_IN_ARCHIVE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.QuickstartVideoDataset.name

fiftyone.zoo.datasets.base.QuickstartVideoDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.QuickstartVideoDataset.tags

fiftyone.zoo.datasets.base.QuickstartVideoDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.QuickstartVideoDataset.supported_splits

fiftyone.zoo.datasets.base.QuickstartVideoDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.QuickstartVideoDataset._download_and_prepare

fiftyone.zoo.datasets.base.QuickstartVideoDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.QuickstartGroupsDataset

fiftyone.zoo.datasets.base.QuickstartGroupsDataset.html

Class

Class

PUBLIC

A small dataset with grouped image and point cloud data.
fiftyone.zoo.datasets.base.QuickstartGroupsDataset._GDRIVE_ID

fiftyone.zoo.datasets.base.QuickstartGroupsDataset.html#_GDRIVE_ID

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.QuickstartGroupsDataset._ARCHIVE_NAME

fiftyone.zoo.datasets.base.QuickstartGroupsDataset.html#_ARCHIVE_NAME

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.QuickstartGroupsDataset._DIR_IN_ARCHIVE

fiftyone.zoo.datasets.base.QuickstartGroupsDataset.html#_DIR_IN_ARCHIVE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.QuickstartGroupsDataset.name

fiftyone.zoo.datasets.base.QuickstartGroupsDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.QuickstartGroupsDataset.tags

fiftyone.zoo.datasets.base.QuickstartGroupsDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.QuickstartGroupsDataset.supported_splits

fiftyone.zoo.datasets.base.QuickstartGroupsDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.QuickstartGroupsDataset.has_patches

fiftyone.zoo.datasets.base.QuickstartGroupsDataset.html#has_patches

Attribute

Property

PUBLIC

Whether the dataset has patches that may need to be applied to already downloaded files.
fiftyone.zoo.datasets.base.QuickstartGroupsDataset._download_and_prepare

fiftyone.zoo.datasets.base.QuickstartGroupsDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.QuickstartGroupsDataset._patch_if_necessary

fiftyone.zoo.datasets.base.QuickstartGroupsDataset.html#_patch_if_necessary

Function

Method

PRIVATE

Internal method called when an already downloaded dataset may need to be patched.
fiftyone.zoo.datasets.base.Quickstart3DDataset

fiftyone.zoo.datasets.base.Quickstart3DDataset.html

Class

Class

PUBLIC

A small 3D dataset with meshes, point clouds, and oriented bounding boxes.
fiftyone.zoo.datasets.base.Quickstart3DDataset._GDRIVE_ID

fiftyone.zoo.datasets.base.Quickstart3DDataset.html#_GDRIVE_ID

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.Quickstart3DDataset._ARCHIVE_NAME

fiftyone.zoo.datasets.base.Quickstart3DDataset.html#_ARCHIVE_NAME

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.Quickstart3DDataset._DIR_IN_ARCHIVE

fiftyone.zoo.datasets.base.Quickstart3DDataset.html#_DIR_IN_ARCHIVE

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.base.Quickstart3DDataset.name

fiftyone.zoo.datasets.base.Quickstart3DDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.Quickstart3DDataset.tags

fiftyone.zoo.datasets.base.Quickstart3DDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.Quickstart3DDataset.supported_splits

fiftyone.zoo.datasets.base.Quickstart3DDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.Quickstart3DDataset._download_and_prepare

fiftyone.zoo.datasets.base.Quickstart3DDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.UCF101Dataset

fiftyone.zoo.datasets.base.UCF101Dataset.html

Class

Class

PUBLIC

UCF101 is an action recognition data set of realistic action videos, collected from YouTube, having 101 action categories. This data set is an extension of UCF50 data set which has 50 action categories.
fiftyone.zoo.datasets.base.UCF101Dataset.fold

fiftyone.zoo.datasets.base.UCF101Dataset.html#fold

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.UCF101Dataset.__init__

fiftyone.zoo.datasets.base.UCF101Dataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.base.UCF101Dataset.name

fiftyone.zoo.datasets.base.UCF101Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.base.UCF101Dataset.tags

fiftyone.zoo.datasets.base.UCF101Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.base.UCF101Dataset.parameters

fiftyone.zoo.datasets.base.UCF101Dataset.html#parameters

Attribute

Property

PUBLIC

An optional dict of parameters describing the configuration of the zoo dataset when it was downloaded.
fiftyone.zoo.datasets.base.UCF101Dataset.supported_splits

fiftyone.zoo.datasets.base.UCF101Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.base.UCF101Dataset._download_and_prepare

fiftyone.zoo.datasets.base.UCF101Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.base.AVAILABLE_DATASETS

fiftyone.zoo.datasets.base.html#AVAILABLE_DATASETS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.zoo.datasets.base._should_patch_pcd

fiftyone.zoo.datasets.base.html#_should_patch_pcd

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets.base._download_and_extract_archive

fiftyone.zoo.datasets.base.html#_download_and_extract_archive

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets.base._move_dir

fiftyone.zoo.datasets.base.html#_move_dir

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets.tf._TFDS_IMPORT_ERROR

fiftyone.zoo.datasets.tf.html#_TFDS_IMPORT_ERROR

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.tf._callback

fiftyone.zoo.datasets.tf.html#_callback

Attribute

Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.tf.tfds

fiftyone.zoo.datasets.tf.html#tfds

Attribute

Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.tf.TFDSDataset

fiftyone.zoo.datasets.tf.TFDSDataset.html

Class

Class

PUBLIC

Base class for zoo datasets that are provided via the tensorflow_datasets package.
fiftyone.zoo.datasets.tf.MNISTDataset

fiftyone.zoo.datasets.tf.MNISTDataset.html

Class

Class

PUBLIC

The MNIST database of handwritten digits.
fiftyone.zoo.datasets.tf.MNISTDataset.name

fiftyone.zoo.datasets.tf.MNISTDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.tf.MNISTDataset.tags

fiftyone.zoo.datasets.tf.MNISTDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.tf.MNISTDataset.supported_splits

fiftyone.zoo.datasets.tf.MNISTDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.tf.MNISTDataset._download_and_prepare

fiftyone.zoo.datasets.tf.MNISTDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.tf.FashionMNISTDataset

fiftyone.zoo.datasets.tf.FashionMNISTDataset.html

Class

Class

PUBLIC

The Fashion-MNIST database of Zalando's fashion article images.
fiftyone.zoo.datasets.tf.FashionMNISTDataset.name

fiftyone.zoo.datasets.tf.FashionMNISTDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.tf.FashionMNISTDataset.tags

fiftyone.zoo.datasets.tf.FashionMNISTDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.tf.FashionMNISTDataset.supported_splits

fiftyone.zoo.datasets.tf.FashionMNISTDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.tf.FashionMNISTDataset._download_and_prepare

fiftyone.zoo.datasets.tf.FashionMNISTDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.tf.CIFAR10Dataset

fiftyone.zoo.datasets.tf.CIFAR10Dataset.html

Class

Class

PUBLIC

The CIFAR-10 dataset of images.
fiftyone.zoo.datasets.tf.CIFAR10Dataset.name

fiftyone.zoo.datasets.tf.CIFAR10Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.tf.CIFAR10Dataset.tags

fiftyone.zoo.datasets.tf.CIFAR10Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.tf.CIFAR10Dataset.supported_splits

fiftyone.zoo.datasets.tf.CIFAR10Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.tf.CIFAR10Dataset._download_and_prepare

fiftyone.zoo.datasets.tf.CIFAR10Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.tf.CIFAR100Dataset

fiftyone.zoo.datasets.tf.CIFAR100Dataset.html

Class

Class

PUBLIC

The CIFAR-100 dataset of images.
fiftyone.zoo.datasets.tf.CIFAR100Dataset.name

fiftyone.zoo.datasets.tf.CIFAR100Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.tf.CIFAR100Dataset.tags

fiftyone.zoo.datasets.tf.CIFAR100Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.tf.CIFAR100Dataset.supported_splits

fiftyone.zoo.datasets.tf.CIFAR100Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.tf.CIFAR100Dataset._download_and_prepare

fiftyone.zoo.datasets.tf.CIFAR100Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.tf.ImageNet2012Dataset

fiftyone.zoo.datasets.tf.ImageNet2012Dataset.html

Class

Class

PUBLIC

The ImageNet 2012 dataset.
fiftyone.zoo.datasets.tf.ImageNet2012Dataset.source_dir

fiftyone.zoo.datasets.tf.ImageNet2012Dataset.html#source_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.tf.ImageNet2012Dataset.__init__

fiftyone.zoo.datasets.tf.ImageNet2012Dataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.tf.ImageNet2012Dataset.name

fiftyone.zoo.datasets.tf.ImageNet2012Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.tf.ImageNet2012Dataset.tags

fiftyone.zoo.datasets.tf.ImageNet2012Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.tf.ImageNet2012Dataset.supported_splits

fiftyone.zoo.datasets.tf.ImageNet2012Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.tf.ImageNet2012Dataset.requires_manual_download

fiftyone.zoo.datasets.tf.ImageNet2012Dataset.html#requires_manual_download

Attribute

Property

PUBLIC

Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded.
fiftyone.zoo.datasets.tf.ImageNet2012Dataset._download_and_prepare

fiftyone.zoo.datasets.tf.ImageNet2012Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.tf.VOC2007Dataset

fiftyone.zoo.datasets.tf.VOC2007Dataset.html

Class

Class

PUBLIC

The dataset for the PASCAL Visual Object Classes Challenge 2007 (VOC2007) for the detection competition.
fiftyone.zoo.datasets.tf.VOC2007Dataset.name

fiftyone.zoo.datasets.tf.VOC2007Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.tf.VOC2007Dataset.tags

fiftyone.zoo.datasets.tf.VOC2007Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.tf.VOC2007Dataset.supported_splits

fiftyone.zoo.datasets.tf.VOC2007Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.tf.VOC2007Dataset._download_and_prepare

fiftyone.zoo.datasets.tf.VOC2007Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.tf.VOC2012Dataset

fiftyone.zoo.datasets.tf.VOC2012Dataset.html

Class

Class

PUBLIC

The dataset for the PASCAL Visual Object Classes Challenge 2012 (VOC2012) for the detection competition.
fiftyone.zoo.datasets.tf.VOC2012Dataset.name

fiftyone.zoo.datasets.tf.VOC2012Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.tf.VOC2012Dataset.tags

fiftyone.zoo.datasets.tf.VOC2012Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.tf.VOC2012Dataset.supported_splits

fiftyone.zoo.datasets.tf.VOC2012Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.tf.VOC2012Dataset._download_and_prepare

fiftyone.zoo.datasets.tf.VOC2012Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.tf.AVAILABLE_DATASETS

fiftyone.zoo.datasets.tf.html#AVAILABLE_DATASETS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.zoo.datasets.tf._TFDSImageClassificationSampleParser

fiftyone.zoo.datasets.tf._TFDSImageClassificationSampleParser.html

Class

Class

PRIVATE

Undocumented
fiftyone.zoo.datasets.tf._TFDSImageClassificationSampleParser.__init__

fiftyone.zoo.datasets.tf._TFDSImageClassificationSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.tf._TFDSImageClassificationSampleParser.image_field

fiftyone.zoo.datasets.tf._TFDSImageClassificationSampleParser.html#image_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.tf._TFDSImageClassificationSampleParser.label_field

fiftyone.zoo.datasets.tf._TFDSImageClassificationSampleParser.html#label_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.tf._TFDSImageClassificationSampleParser._get_image

fiftyone.zoo.datasets.tf._TFDSImageClassificationSampleParser.html#_get_image

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.datasets.tf._TFDSImageClassificationSampleParser.get_label

fiftyone.zoo.datasets.tf._TFDSImageClassificationSampleParser.html#get_label

Function

Method

PUBLIC

Returns the label for the current sample.
fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser

fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser.html

Class

Class

PRIVATE

Undocumented
fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser.__init__

fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser.image_field

fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser.html#image_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser.objects_field

fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser.html#objects_field

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser._get_image

fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser.html#_get_image

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser.get_label

fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser.html#get_label

Function

Method

PUBLIC

Returns the label for the current sample.
fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser._parse_label

fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser.html#_parse_label

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser._parse_bbox

fiftyone.zoo.datasets.tf._TFDSImageDetectionSampleParser.html#_parse_bbox

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.datasets.tf._download_and_prepare

fiftyone.zoo.datasets.tf.html#_download_and_prepare

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets.torch._TORCH_IMPORT_ERROR

fiftyone.zoo.datasets.torch.html#_TORCH_IMPORT_ERROR

Attribute

Constant

PRIVATE

Undocumented
fiftyone.zoo.datasets.torch._callback

fiftyone.zoo.datasets.torch.html#_callback

Attribute

Variable

PRIVATE

Undocumented
fiftyone.zoo.datasets.torch.torchvision

fiftyone.zoo.datasets.torch.html#torchvision

Attribute

Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.torch.TorchVisionDataset

fiftyone.zoo.datasets.torch.TorchVisionDataset.html

Class

Class

PUBLIC

Base class for zoo datasets that are provided via the torchvision:torchvision.datasets package.
fiftyone.zoo.datasets.torch.MNISTDataset

fiftyone.zoo.datasets.torch.MNISTDataset.html

Class

Class

PUBLIC

The MNIST database of handwritten digits.
fiftyone.zoo.datasets.torch.MNISTDataset.name

fiftyone.zoo.datasets.torch.MNISTDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.torch.MNISTDataset.tags

fiftyone.zoo.datasets.torch.MNISTDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.torch.MNISTDataset.supported_splits

fiftyone.zoo.datasets.torch.MNISTDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.torch.MNISTDataset._download_and_prepare

fiftyone.zoo.datasets.torch.MNISTDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.torch.FashionMNISTDataset

fiftyone.zoo.datasets.torch.FashionMNISTDataset.html

Class

Class

PUBLIC

The Fashion-MNIST database of Zalando's fashion article images.
fiftyone.zoo.datasets.torch.FashionMNISTDataset.name

fiftyone.zoo.datasets.torch.FashionMNISTDataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.torch.FashionMNISTDataset.tags

fiftyone.zoo.datasets.torch.FashionMNISTDataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.torch.FashionMNISTDataset.supported_splits

fiftyone.zoo.datasets.torch.FashionMNISTDataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.torch.FashionMNISTDataset._download_and_prepare

fiftyone.zoo.datasets.torch.FashionMNISTDataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.torch.CIFAR10Dataset

fiftyone.zoo.datasets.torch.CIFAR10Dataset.html

Class

Class

PUBLIC

The CIFAR-10 dataset consists of 60,000 32 x 32 color images in 10 classes, with 6,000 images per class. There are 50,000 training images and 10,000 test images.
fiftyone.zoo.datasets.torch.CIFAR10Dataset.name

fiftyone.zoo.datasets.torch.CIFAR10Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.torch.CIFAR10Dataset.tags

fiftyone.zoo.datasets.torch.CIFAR10Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.torch.CIFAR10Dataset.supported_splits

fiftyone.zoo.datasets.torch.CIFAR10Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.torch.CIFAR10Dataset._download_and_prepare

fiftyone.zoo.datasets.torch.CIFAR10Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.torch.CIFAR100Dataset

fiftyone.zoo.datasets.torch.CIFAR100Dataset.html

Class

Class

PUBLIC

The CIFAR-100 dataset of images.
fiftyone.zoo.datasets.torch.CIFAR100Dataset.name

fiftyone.zoo.datasets.torch.CIFAR100Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.torch.CIFAR100Dataset.tags

fiftyone.zoo.datasets.torch.CIFAR100Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.torch.CIFAR100Dataset.supported_splits

fiftyone.zoo.datasets.torch.CIFAR100Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.torch.CIFAR100Dataset._download_and_prepare

fiftyone.zoo.datasets.torch.CIFAR100Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.torch.ImageNet2012Dataset

fiftyone.zoo.datasets.torch.ImageNet2012Dataset.html

Class

Class

PUBLIC

The ImageNet 2012 dataset.
fiftyone.zoo.datasets.torch.ImageNet2012Dataset.source_dir

fiftyone.zoo.datasets.torch.ImageNet2012Dataset.html#source_dir

Attribute

Instance Variable

PUBLIC

Undocumented
fiftyone.zoo.datasets.torch.ImageNet2012Dataset.__init__

fiftyone.zoo.datasets.torch.ImageNet2012Dataset.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.torch.ImageNet2012Dataset.name

fiftyone.zoo.datasets.torch.ImageNet2012Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.torch.ImageNet2012Dataset.tags

fiftyone.zoo.datasets.torch.ImageNet2012Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.torch.ImageNet2012Dataset.supported_splits

fiftyone.zoo.datasets.torch.ImageNet2012Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.torch.ImageNet2012Dataset.requires_manual_download

fiftyone.zoo.datasets.torch.ImageNet2012Dataset.html#requires_manual_download

Attribute

Property

PUBLIC

Whether this dataset requires some files to be manually downloaded by the user before the dataset can be loaded.
fiftyone.zoo.datasets.torch.ImageNet2012Dataset._download_and_prepare

fiftyone.zoo.datasets.torch.ImageNet2012Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.torch.VOC2007Dataset

fiftyone.zoo.datasets.torch.VOC2007Dataset.html

Class

Class

PUBLIC

The dataset for the PASCAL Visual Object Classes Challenge 2007 (VOC2007) for the classification and detection competitions.
fiftyone.zoo.datasets.torch.VOC2007Dataset.name

fiftyone.zoo.datasets.torch.VOC2007Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.torch.VOC2007Dataset.tags

fiftyone.zoo.datasets.torch.VOC2007Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.torch.VOC2007Dataset.supported_splits

fiftyone.zoo.datasets.torch.VOC2007Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.torch.VOC2007Dataset._download_and_prepare

fiftyone.zoo.datasets.torch.VOC2007Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.torch.VOC2012Dataset

fiftyone.zoo.datasets.torch.VOC2012Dataset.html

Class

Class

PUBLIC

The dataset for the PASCAL Visual Object Classes Challenge 2012 (VOC2012) for the Classification and Detection competitions.
fiftyone.zoo.datasets.torch.VOC2012Dataset.name

fiftyone.zoo.datasets.torch.VOC2012Dataset.html#name

Attribute

Property

PUBLIC

The name of the dataset.
fiftyone.zoo.datasets.torch.VOC2012Dataset.tags

fiftyone.zoo.datasets.torch.VOC2012Dataset.html#tags

Attribute

Property

PUBLIC

A tuple of tags for the dataset.
fiftyone.zoo.datasets.torch.VOC2012Dataset.supported_splits

fiftyone.zoo.datasets.torch.VOC2012Dataset.html#supported_splits

Attribute

Property

PUBLIC

A tuple of supported splits for the dataset, or None if the dataset does not have splits.
fiftyone.zoo.datasets.torch.VOC2012Dataset._download_and_prepare

fiftyone.zoo.datasets.torch.VOC2012Dataset.html#_download_and_prepare

Function

Method

PRIVATE

Internal implementation of downloading the dataset and preparing it for use in the given directory.
fiftyone.zoo.datasets.torch.AVAILABLE_DATASETS

fiftyone.zoo.datasets.torch.html#AVAILABLE_DATASETS

Attribute

Constant

PUBLIC

Undocumented
fiftyone.zoo.datasets.torch._VOCDetectionSampleParser

fiftyone.zoo.datasets.torch._VOCDetectionSampleParser.html

Class

Class

PRIVATE

Undocumented
fiftyone.zoo.datasets.torch._VOCDetectionSampleParser.__init__

fiftyone.zoo.datasets.torch._VOCDetectionSampleParser.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.datasets.torch._VOCDetectionSampleParser._parse_label

fiftyone.zoo.datasets.torch._VOCDetectionSampleParser.html#_parse_label

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.datasets.torch._download_and_prepare

fiftyone.zoo.datasets.torch.html#_download_and_prepare

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets.torch._parse_voc_detection_labels

fiftyone.zoo.datasets.torch.html#_parse_voc_detection_labels

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets.torch._parse_coco_detection_labels_map

fiftyone.zoo.datasets.torch.html#_parse_coco_detection_labels_map

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.datasets.torch._parse_classification_labels

fiftyone.zoo.datasets.torch.html#_parse_classification_labels

Function

Function

PRIVATE

Undocumented
fiftyone.zoo.models.torch.logger

fiftyone.zoo.models.torch.html#logger

Attribute

Variable

PUBLIC

Undocumented
fiftyone.zoo.models.torch.TorchvisionImageModelConfig

fiftyone.zoo.models.torch.TorchvisionImageModelConfig.html

Class

Class

PUBLIC

Configuration for running a TorchvisionImageModel.
fiftyone.zoo.models.torch.TorchvisionImageModelConfig.__init__

fiftyone.zoo.models.torch.TorchvisionImageModelConfig.html#__init__

Function

Method

PUBLIC

Undocumented
fiftyone.zoo.models.torch.TorchvisionImageModel

fiftyone.zoo.models.torch.TorchvisionImageModel.html

Class

Class

PUBLIC

Wrapper for evaluating a torchvision:torchvision.models model on images.
fiftyone.zoo.models.torch.TorchvisionImageModel._download_model

fiftyone.zoo.models.torch.TorchvisionImageModel.html#_download_model

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.models.torch.TorchvisionImageModel._load_model

fiftyone.zoo.models.torch.TorchvisionImageModel.html#_load_model

Function

Method

PRIVATE

Undocumented
fiftyone.zoo.models.torch._make_load_state_dict_from_url_monkey_patcher

fiftyone.zoo.models.torch.html#_make_load_state_dict_from_url_monkey_patcher

Function

Function

PRIVATE

Monkey patches all instances of load_state_dict_from_url() that are reachable from the given entrypoint function in the torchvision:torchvision.models namespace so that models will be loaded from model_dir...